diff --git a/doc/devel/Doxyfile b/doc/devel/Doxyfile index 61fa123428..e42f9b8885 100644 --- a/doc/devel/Doxyfile +++ b/doc/devel/Doxyfile @@ -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 \ diff --git a/doc/devel/mainpage.dox b/doc/devel/mainpage.dox index 9cbbd0ffea..ae851d15a8 100644 --- a/doc/devel/mainpage.dox +++ b/doc/devel/mainpage.dox @@ -153,7 +153,6 @@ * - @subpage logDeveloperUse * - @subpage logNotes * - @subpage LoggingApi - * - @subpage crossCompile * - @subpage debug * - @subpage docs * - Documentation Warnings and Errors diff --git a/src/hooks/d2/gss_tsig/gss_tsig.dox b/src/hooks/d2/gss_tsig/gss_tsig.dox index 9fa64c1a4e..4353d40e34 100644 --- a/src/hooks/d2/gss_tsig/gss_tsig.dox +++ b/src/hooks/d2/gss_tsig/gss_tsig.dox @@ -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 diff --git a/src/hooks/dhcp/class_cmds/class_cmds.dox b/src/hooks/dhcp/class_cmds/class_cmds.dox index 4d665f3c00..11afe2a13c 100644 --- a/src/hooks/dhcp/class_cmds/class_cmds.dox +++ b/src/hooks/dhcp/class_cmds/class_cmds.dox @@ -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 diff --git a/src/hooks/dhcp/ddns_tuning/ddns_tuning.dox b/src/hooks/dhcp/ddns_tuning/ddns_tuning.dox index 7ef64641bb..d9c24f5c12 100644 --- a/src/hooks/dhcp/ddns_tuning/ddns_tuning.dox +++ b/src/hooks/dhcp/ddns_tuning/ddns_tuning.dox @@ -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 diff --git a/src/hooks/dhcp/flex_id/libdhcp_flex_id.dox b/src/hooks/dhcp/flex_id/libdhcp_flex_id.dox index 4cf637a249..18e264840c 100644 --- a/src/hooks/dhcp/flex_id/libdhcp_flex_id.dox +++ b/src/hooks/dhcp/flex_id/libdhcp_flex_id.dox @@ -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 diff --git a/src/hooks/dhcp/forensic_log/command_callouts.cc b/src/hooks/dhcp/forensic_log/command_callouts.cc index 6d99ec2dd4..645e36f435 100644 --- a/src/hooks/dhcp/forensic_log/command_callouts.cc +++ b/src/hooks/dhcp/forensic_log/command_callouts.cc @@ -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 diff --git a/src/hooks/dhcp/forensic_log/libdhcp_legal_log.dox b/src/hooks/dhcp/forensic_log/libdhcp_legal_log.dox index 8421bdfe33..a0d2d3f22e 100644 --- a/src/hooks/dhcp/forensic_log/libdhcp_legal_log.dox +++ b/src/hooks/dhcp/forensic_log/libdhcp_legal_log.dox @@ -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 diff --git a/src/hooks/dhcp/forensic_log/rotating_file.h b/src/hooks/dhcp/forensic_log/rotating_file.h index 9d0adef891..13382147e9 100644 --- a/src/hooks/dhcp/forensic_log/rotating_file.h +++ b/src/hooks/dhcp/forensic_log/rotating_file.h @@ -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. diff --git a/src/hooks/dhcp/host_cache/host_cache.dox b/src/hooks/dhcp/host_cache/host_cache.dox index 3c0c3c0551..9e79f25daa 100644 --- a/src/hooks/dhcp/host_cache/host_cache.dox +++ b/src/hooks/dhcp/host_cache/host_cache.dox @@ -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 diff --git a/src/hooks/dhcp/host_cache/host_cache.h b/src/hooks/dhcp/host_cache/host_cache.h index b941bbab3b..9ae298a8da 100644 --- a/src/hooks/dhcp/host_cache/host_cache.h +++ b/src/hooks/dhcp/host_cache/host_cache.h @@ -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. /// diff --git a/src/hooks/dhcp/host_cache/host_cache_impl.h b/src/hooks/dhcp/host_cache/host_cache_impl.h index 8978c819e5..56a5f88e6c 100644 --- a/src/hooks/dhcp/host_cache/host_cache_impl.h +++ b/src/hooks/dhcp/host_cache/host_cache_impl.h @@ -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. /// diff --git a/src/hooks/dhcp/host_cmds/host_cmds.dox b/src/hooks/dhcp/host_cmds/host_cmds.dox index b893d87af7..849e1fa560 100644 --- a/src/hooks/dhcp/host_cmds/host_cmds.dox +++ b/src/hooks/dhcp/host_cmds/host_cmds.dox @@ -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 diff --git a/src/hooks/dhcp/lease_query/lease_query.dox b/src/hooks/dhcp/lease_query/lease_query.dox index d420fc95a1..9cea07ba61 100644 --- a/src/hooks/dhcp/lease_query/lease_query.dox +++ b/src/hooks/dhcp/lease_query/lease_query.dox @@ -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 diff --git a/src/hooks/dhcp/lease_query/lease_query_connection.h b/src/hooks/dhcp/lease_query/lease_query_connection.h index c88fdba9d9..f8d05eb3e9 100644 --- a/src/hooks/dhcp/lease_query/lease_query_connection.h +++ b/src/hooks/dhcp/lease_query/lease_query_connection.h @@ -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(); diff --git a/src/hooks/dhcp/limits/libdhcp_limits.dox b/src/hooks/dhcp/limits/libdhcp_limits.dox index e43ace2593..fdb1fa1374 100644 --- a/src/hooks/dhcp/limits/libdhcp_limits.dox +++ b/src/hooks/dhcp/limits/libdhcp_limits.dox @@ -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 diff --git a/src/hooks/dhcp/ping_check/ping_channel.h b/src/hooks/dhcp/ping_check/ping_channel.h index ad798188e3..064e7a2a82 100644 --- a/src/hooks/dhcp/ping_check/ping_channel.h +++ b/src/hooks/dhcp/ping_check/ping_channel.h @@ -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::asyncReceive() /// otherwise it simply returns. If the call to asyncReceive() fails /// it calls @c stopChannel() otherwise, when it completes it will /// invoke @c socketReadCallback(). diff --git a/src/hooks/dhcp/ping_check/ping_check.dox b/src/hooks/dhcp/ping_check/ping_check.dox index a7fbe839c0..d685530e12 100644 --- a/src/hooks/dhcp/ping_check/ping_check.dox +++ b/src/hooks/dhcp/ping_check/ping_check.dox @@ -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 diff --git a/src/hooks/dhcp/radius/radius.dox b/src/hooks/dhcp/radius/radius.dox index 6a59b6bd25..92faa32557 100644 --- a/src/hooks/dhcp/radius/radius.dox +++ b/src/hooks/dhcp/radius/radius.dox @@ -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 diff --git a/src/hooks/dhcp/run_script/run_script.h b/src/hooks/dhcp/run_script/run_script.h index 201f0c56c1..151032b5c6 100644 --- a/src/hooks/dhcp/run_script/run_script.h +++ b/src/hooks/dhcp/run_script/run_script.h @@ -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; } diff --git a/src/hooks/dhcp/subnet_cmds/subnet_cmds.cc b/src/hooks/dhcp/subnet_cmds/subnet_cmds.cc index a48be0c82a..5cc4dc6ef0 100644 --- a/src/hooks/dhcp/subnet_cmds/subnet_cmds.cc +++ b/src/hooks/dhcp/subnet_cmds/subnet_cmds.cc @@ -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. diff --git a/src/hooks/dhcp/subnet_cmds/subnet_cmds.dox b/src/hooks/dhcp/subnet_cmds/subnet_cmds.dox index 9eb27c28eb..f266603def 100644 --- a/src/hooks/dhcp/subnet_cmds/subnet_cmds.dox +++ b/src/hooks/dhcp/subnet_cmds/subnet_cmds.dox @@ -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 and in particular its section about hooks: Hooks Developer's Guide. -@section host_cmds Overview +@section subnet_cmds Overview ## Introduction @todo diff --git a/src/lib/eval/token.h b/src/lib/eval/token.h index 59d0b8394a..7979da5249 100644 --- a/src/lib/eval/token.h +++ b/src/lib/eval/token.h @@ -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. diff --git a/src/lib/process/daemon.h b/src/lib/process/daemon.h index 7e2c2d11c0..791d811f71 100644 --- a/src/lib/process/daemon.h +++ b/src/lib/process/daemon.h @@ -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); diff --git a/src/lib/util/filesystem.h b/src/lib/util/filesystem.h index 16f8bf096d..7b93a61db1 100644 --- a/src/lib/util/filesystem.h +++ b/src/lib/util/filesystem.h @@ -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. ///