mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-29 04:57:52 +00:00
Code Issues Releases Wiki Activity

[#3779] fixed doxygen

Browse Source
This commit is contained in:
Razvan Becheriu 2025-06-13 16:31:00 +03:00
parent 05a2a65e0a
commit d2245874c9
25 changed files with 62 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/devel/Doxyfile
View File

@ -946,12 +946,25 @@ INPUT = ../../src/bin/agent \
../../src/bin/lfc \
../../src/bin/netconf \
../../src/bin/perfdhcp \
../../src/hooks/d2/gss_tsig \
../../src/hooks/dhcp/bootp \
../../src/hooks/dhcp/class_cmds \
../../src/hooks/dhcp/ddns_tuning \
../../src/hooks/dhcp/flex_id \
../../src/hooks/dhcp/flex_option \
../../src/hooks/dhcp/forensic_log \
../../src/hooks/dhcp/high_availability \
../../src/hooks/dhcp/host_cache \
../../src/hooks/dhcp/host_cmds \
../../src/hooks/dhcp/lease_cmds \
../../src/hooks/dhcp/lease_query \
../../src/hooks/dhcp/limits \
../../src/hooks/dhcp/perfmon \
../../src/hooks/dhcp/ping_check \
../../src/hooks/dhcp/radius \
../../src/hooks/dhcp/run_script \
../../src/hooks/dhcp/stat_cmds \
../../src/hooks/dhcp/subnet_cmds \
../../src/hooks/dhcp/user_chk \
../../src/lib/asiodns \
../../src/lib/asiolink \

1
doc/devel/mainpage.dox
View File

@ -153,7 +153,6 @@
* - @subpage logDeveloperUse
* - @subpage logNotes
* - @subpage LoggingApi
* - @subpage crossCompile
* - @subpage debug
* - @subpage docs
* - <a href="./doxygen-error.log"><b>Documentation Warnings and Errors</b></a>

2
src/hooks/d2/gss_tsig/gss_tsig.dox
View File

@ -6,7 +6,7 @@
/**
@mainpage Kea GSS-TSIG Hooks Library
@page libddns_gss_tsig Kea GSS-TSIG Hooks Library
Welcome to Kea GSS-TSIG Hooks Library. This documentation is addressed
at developers who are interested in internal operation of the

2
src/hooks/dhcp/class_cmds/class_cmds.dox
View File

@ -6,7 +6,7 @@
/**
@mainpage Kea Class Commands Hooks Library
@page libdhcp_class_cmds Kea Class Commands Hooks Library
Welcome to Kea Class Commands Hooks Library. This documentation is
addressed at developers who are interested in internal operation of the

2
src/hooks/dhcp/ddns_tuning/ddns_tuning.dox
View File

@ -6,7 +6,7 @@
/**
@mainpage Kea DDNS Tuning Hooks Library
@page libdhcp_ddns_tuning Kea DDNS Tuning Hooks Library
Welcome to Kea DDNS Tuning Hooks Library. This documentation is
addressed at developers who are interested in internal operation of the

2
src/hooks/dhcp/flex_id/libdhcp_flex_id.dox
View File

@ -6,7 +6,7 @@
/**
@mainpage Kea Flexible Identifier Hooks Library
@page libdhcp_flex_id Kea Flexible Identifier Hooks Library
Welcome to Kea Flexible Identifier Hooks Library. This documentation is
addressed at developers who are interested in internal operation of the

2
src/hooks/dhcp/forensic_log/command_callouts.cc
View File

@ -109,7 +109,7 @@ bool isPrefix(ConstElementPtr arguments) {
///
/// Looks for either a lease valid lifetime or expiry from which to
/// generate the duration text using @ref
/// isc::legal_log::LegalLogMgr::genDurationString().
/// isc::dhcp::LegalLogMgr::genDurationString().
///
/// @param handle CalloutHandle which provides access to context.
/// @param os output stream to which the text is output

2
src/hooks/dhcp/forensic_log/libdhcp_legal_log.dox
View File

@ -6,7 +6,7 @@
/**
@mainpage Kea Legal Log Hooks Library
@page libdhcp_legal_log Kea Legal Log Hooks Library
Welcome to Kea Legal Log Hooks Library. This documentation is
addressed at developers who are interested in internal operation of the

2
src/hooks/dhcp/forensic_log/rotating_file.h
View File

@ -117,8 +117,6 @@ public:
/// was opened. Kea does not wait for the process to finish.
///
/// @param parameters The library parameters.
///
/// @return The RotatingFile forensic log backend.
void apply(const isc::db::DatabaseConnection::ParameterMap& parameters);
/// @brief Opens the current file for writing.

2
src/hooks/dhcp/host_cache/host_cache.dox
View File

@ -6,7 +6,7 @@
/**
@mainpage Kea Host Cache Hooks Library
@page libdhcp_host_cache Kea Host Cache Hooks Library
Welcome to Kea Host Cache Hooks Library. This documentation is
addressed at developers who are interested in internal operation of the

3
src/hooks/dhcp/host_cache/host_cache.h
View File

@ -378,7 +378,8 @@ public:
const uint8_t* identifier_begin,
const size_t identifier_len);
/// @brief Implements @ref BaseHostDataSource::update() for HostCache.
/// @brief Implements @ref isc::dhcp::BaseHostDataSource::update() for
/// HostCache.
///
/// Attempts to update an existing host entry.
///

3
src/hooks/dhcp/host_cache/host_cache_impl.h
View File

@ -226,7 +226,8 @@ public:
/// @return number of conflicts limited to one if overwrite is false.
size_t insert(const dhcp::ConstHostPtr& host, bool overwrite);
/// @brief Implements @ref BaseHostDataSource::update() for HostCacheImpl.
/// @brief Implements @ref isc::dhcp::BaseHostDataSource::update() for
/// HostCacheImpl.
///
/// Attempts to update an existing host entry.
///

2
src/hooks/dhcp/host_cmds/host_cmds.dox
View File

@ -6,7 +6,7 @@
/**
@mainpage Kea Host Commands Hooks Library
@page libdhcp_host_cmds Kea Host Commands Hooks Library
Welcome to Kea Host Commands Hooks Library. This documentation is
addressed at developers who are interested in internal operation of the

2
src/hooks/dhcp/lease_query/lease_query.dox
View File

@ -6,7 +6,7 @@
/**
@mainpage Kea Lease Query Hooks Library
@page libdhcp_lease_query Kea Lease Query Hooks Library
Welcome to Kea Lease QueryHooks Library. This documentation is
addressed at developers who are interested in internal operation of the

8
src/hooks/dhcp/lease_query/lease_query_connection.h
View File

@ -227,7 +227,7 @@ public:
/// @brief Class/static version of sendNextResponse.
///
/// @brief wptr Weak pointer to a lease query connection.
/// @param wptr Weak pointer to a lease query connection.
static void doSendNextResponse(LeaseQueryConnectionWPtr wptr) {
LeaseQueryConnectionPtr ptr = wptr.lock();
if (!ptr) {
@ -338,7 +338,7 @@ public:
/// @brief Class/static version of pushToSend.
///
/// @brief wptr Weak pointer to a lease query connection.
/// @param wptr Weak pointer to a lease query connection.
/// @param response Pointer to the response to send.
/// @return True if the response can be sent, False otherwise.
static bool doPushToSend(LeaseQueryConnectionWPtr wptr,
@ -357,7 +357,7 @@ public:
/// @brief Class/static version of post.
///
/// @brief wptr Weak pointer to a lease query connection.
/// @param wptr Weak pointer to a lease query connection.
/// @param callback The callback to post.
static void doPost(LeaseQueryConnectionWPtr wptr,
const BlqPostCbArg& callback) {
@ -376,7 +376,7 @@ public:
/// @brief Class/static version of queryComplete.
///
/// @brief wptr Weak pointer to a lease query connection.
/// @param wptr Weak pointer to a lease query connection.
/// @param xid Xid of the query that has finished.
static void doQueryComplete(LeaseQueryConnectionWPtr wptr, const Xid& xid) {
LeaseQueryConnectionPtr ptr = wptr.lock();

2
src/hooks/dhcp/limits/libdhcp_limits.dox
View File

@ -6,7 +6,7 @@
/**
@mainpage Kea Limits Hook Library
@page libdhcp_limits Kea Limits Hook Library
Welcome to Kea's limits hook library. This documentation is addressed at developers who are
interested in the internal workings of the library. This file provides information needed to

2
src/hooks/dhcp/ping_check/ping_channel.h
View File

@ -201,7 +201,7 @@ protected:
/// @brief Initiates an asynchronous socket read.
///
/// If the channel is able to read (is open, not stopping and not
/// currently reading) it invokes @ref PingSocket::asyncReceive()
/// currently reading) it invokes isc::ping_check::ICMPSocket<SocketCallback>::asyncReceive()
/// otherwise it simply returns. If the call to asyncReceive() fails
/// it calls @c stopChannel() otherwise, when it completes it will
/// invoke @c socketReadCallback().

2
src/hooks/dhcp/ping_check/ping_check.dox
View File

@ -6,7 +6,7 @@
/**
@mainpage Kea Ping Check Hooks Library
@page libdhcp_ping_check Kea Ping Check Hooks Library
Welcome to Kea Ping Check Hooks Library. This documentation is
addressed at developers who are interested in internal operation of the

2
src/hooks/dhcp/radius/radius.dox
View File

@ -6,7 +6,7 @@
/**
@mainpage Kea RADIUS Hook Library
@page libdhcp_radius Kea RADIUS Hook Library
Welcome to the Kea RADIUS Hook Library. This documentation is
addressed at developers who are interested in the internal operation of the

19
src/hooks/dhcp/run_script/run_script.h
View File

@ -35,6 +35,7 @@ public:
/// @brief Extract boolean data and append to environment.
///
/// @param vars The process environment variables.
/// @param value The value to be exported to target script environment.
/// @param prefix The prefix for the name of the environment variable.
/// @param suffix The suffix for the name of the environment variable.
@ -45,6 +46,7 @@ public:
/// @brief Extract integer data and append to environment.
///
/// @param vars The process environment variables.
/// @param value The value to be exported to target script environment.
/// @param prefix The prefix for the name of the environment variable.
/// @param suffix The suffix for the name of the environment variable.
@ -55,6 +57,7 @@ public:
/// @brief Extract string data and append to environment.
///
/// @param vars The process environment variables.
/// @param value The value to be exported to target script environment.
/// @param prefix The prefix for the name of the environment variable.
/// @param suffix The suffix for the name of the environment variable.
@ -65,6 +68,7 @@ public:
/// @brief Extract HWAddr data and append to environment.
///
/// @param vars The process environment variables.
/// @param hwaddr The hwaddr to be exported to target script environment.
/// @param prefix The prefix for the name of the environment variable.
/// @param suffix The suffix for the name of the environment variable.
@ -75,6 +79,7 @@ public:
/// @brief Extract ClientId data and append to environment.
///
/// @param vars The process environment variables.
/// @param client_id The client id to be exported to target script environment.
/// @param prefix The prefix for the name of the environment variable.
/// @param suffix The suffix for the name of the environment variable.
@ -85,6 +90,7 @@ public:
/// @brief Extract DUID data and append to environment.
///
/// @param vars The process environment variables.
/// @param duid The duid to be exported to target script environment.
/// @param prefix The prefix for the name of the environment variable.
/// @param suffix The suffix for the name of the environment variable.
@ -95,6 +101,7 @@ public:
/// @brief Extract Option data and append to environment.
///
/// @param vars The process environment variables.
/// @param option The option to be exported to target script environment.
/// @param prefix The prefix for the name of the environment variable.
/// @param suffix The suffix for the name of the environment variable.
@ -105,6 +112,7 @@ public:
/// @brief Extract Option SubOption data and append to environment.
///
/// @param vars The process environment variables.
/// @param option The parent option of the suboption to be exported to
/// target script environment.
/// @param code The code of the suboption.
@ -118,6 +126,7 @@ public:
/// @brief Extract Option6IA data and append to environment.
///
/// @param vars The process environment variables.
/// @param option6IA The option6IA to be exported to target script environment.
/// @param prefix The prefix for the name of the environment variable.
/// @param suffix The suffix for the name of the environment variable.
@ -128,6 +137,7 @@ public:
/// @brief Extract Subnet4 data and append to environment.
///
/// @param vars The process environment variables.
/// @param subnet4 The subnet4 to be exported to target script environment.
/// @param prefix The prefix for the name of the environment variable.
/// @param suffix The suffix for the name of the environment variable.
@ -138,6 +148,7 @@ public:
/// @brief Extract Subnet6 data and append to environment.
///
/// @param vars The process environment variables.
/// @param subnet6 The subnet6 to be exported to target script environment.
/// @param prefix The prefix for the name of the environment variable.
/// @param suffix The suffix for the name of the environment variable.
@ -148,6 +159,7 @@ public:
/// @brief Extract Lease4 data and append to environment.
///
/// @param vars The process environment variables.
/// @param lease4 The lease4 to be exported to target script environment.
/// @param prefix The prefix for the name of the environment variable.
/// @param suffix The suffix for the name of the environment variable.
@ -158,6 +170,7 @@ public:
/// @brief Extract Lease6 data and append to environment.
///
/// @param vars The process environment variables.
/// @param lease6 The lease6 to be exported to target script environment.
/// @param prefix The prefix for the name of the environment variable.
/// @param suffix The suffix for the name of the environment variable.
@ -168,6 +181,7 @@ public:
/// @brief Extract Lease4Collection data and append to environment.
///
/// @param vars The process environment variables.
/// @param leases4 The leases4 to be exported to target script environment.
/// @param prefix The prefix for the name of the environment variable.
/// @param suffix The suffix for the name of the environment variable.
@ -178,6 +192,7 @@ public:
/// @brief Extract Lease6Collection data and append to environment.
///
/// @param vars The process environment variables.
/// @param leases6 The leases6 to be exported to target script environment.
/// @param prefix The prefix for the name of the environment variable.
/// @param suffix The suffix for the name of the environment variable.
@ -188,6 +203,7 @@ public:
/// @brief Extract Pkt4 data and append to environment.
///
/// @param vars The process environment variables.
/// @param pkt4 The pkt4 to be exported to target script environment.
/// @param prefix The prefix for the name of the environment variable.
/// @param suffix The suffix for the name of the environment variable.
@ -198,6 +214,7 @@ public:
/// @brief Extract Pkt6 data and append to environment.
///
/// @param vars The process environment variables.
/// @param pkt6 The pkt6 to be exported to target script environment.
/// @param prefix The prefix for the name of the environment variable.
/// @param suffix The suffix for the name of the environment variable.
@ -231,7 +248,7 @@ public:
/// @brief Set the synchronous call mode for the target script.
///
/// @param name The synchronous call mode for the target script.
/// @param sync The synchronous call mode for the target script.
void setSync(const bool sync) {
sync_ = sync;
}

5
src/hooks/dhcp/subnet_cmds/subnet_cmds.cc
View File

@ -49,8 +49,9 @@ enum UpdateType {
/// It uses an internal representation of the subnet parameters hierarchy to
/// traverse the JSON tree, and functions to detect elements that match the same
/// configuration element or to detect if the element itself is a key identifier
/// of another configuration element. For more details, see @ref mergeDiffAdd
/// @ref mergeDiffDel and @ref extend.
/// of another configuration element. For more details, see
/// @ref isc::data::mergeDiffAdd @ref isc::data::mergeDiffDel and
/// @ref isc::data::extend.
///
/// @tparam SubnetConfigParserType One of the @c Subnet4ConfigParser or
/// @c Subnet6ConfigParser.

4
src/hooks/dhcp/subnet_cmds/subnet_cmds.dox
View File

@ -6,7 +6,7 @@
/**
@mainpage Kea Subnet Commands Hooks Library
@page libdhcp_subnet_cmds Kea Subnet Commands Hooks Library
Welcome to Kea Subnet Commands Hooks Library. This documentation is
addressed at developers who are interested in internal operation of the
@ -19,7 +19,7 @@ Developer's Guide</a> and in particular its section about hooks: <a
href="https://reports.kea.isc.org/dev_guide/df/d46/hooksdgDevelopersGuide.html">
Hooks Developer's Guide</a>.
@section host_cmds Overview
@section subnet_cmds Overview
## Introduction
@todo

2
src/lib/eval/token.h
View File

@ -1326,7 +1326,7 @@ public:
/// @note Does not define its own representation type:
/// simply use the @c TokenOption::RepresentationType
///
/// @brief Constructor that takes an option and sub-option codes as parameter
///
/// Note: There is no constructor that takes names.

2
src/lib/process/daemon.h
View File

@ -144,7 +144,7 @@ public:
/// @note As a side effect prepend the current config file path
/// when the name does not contain a slash.
///
/// @param[in][out] file Reference to the TBW configuration file name.
/// @param file [in/out] Reference to the TBW configuration file name.
/// @throw BadValue when not in the same directory.
void checkWriteConfigFile(std::string& file);

3
src/lib/util/filesystem.h
View File

@ -246,6 +246,9 @@ public:
std::string validateDirectory(const std::string input_path_str,
bool enforce_path = shouldEnforceSecurity()) const;
/// @brief Check if the path has expected permissions.
///
/// @param permissions The expected permissions.
/// @param enforce_perms Enables permsissions check. If false the function
/// simply returns true.
///