From: Francis Dupont Date: Mon, 22 Oct 2018 13:38:20 +0000 (+0200) Subject: [180-address-some-doxygen-warnings-errors] Saved tentative fixes X-Git-Tag: 66-authoritative-flag-in-kea_base~34^2~3 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b6b88ab014c574f906a20942ae1ffe2956ffe836;p=thirdparty%2Fkea.git [180-address-some-doxygen-warnings-errors] Saved tentative fixes --- diff --git a/doc/Doxyfile b/doc/Doxyfile index 29a6a49f6e..8aae92f551 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -775,19 +775,23 @@ INPUT = ../src/bin/agent \ ../src/bin/d2 \ ../src/bin/dhcp4 \ ../src/bin/dhcp6 \ + ../src/bin/lfc \ + ../src/bin/netconf \ ../src/bin/perfdhcp \ ../src/bin/sockcreator \ - ../src/bin/lfc \ ../src/hooks/dhcp/high_availability \ - ../src/hooks/dhcp/user_chk \ ../src/hooks/dhcp/lease_cmds \ ../src/hooks/dhcp/stat_cmds \ + ../src/hooks/dhcp/user_chk \ ../src/lib/asiodns \ ../src/lib/asiolink \ ../src/lib/cc \ ../src/lib/cfgrpt \ ../src/lib/config \ + ../src/lib/config_backend \ + ../src/lib/cql \ ../src/lib/cryptolink \ + ../src/lib/database \ ../src/lib/dhcp \ ../src/lib/dhcp_ddns \ ../src/lib/dhcpsrv \ @@ -801,6 +805,8 @@ INPUT = ../src/bin/agent \ ../src/lib/log \ ../src/lib/log/compiler \ ../src/lib/log/interprocess \ + ../src/lib/mysql \ + ../src/lib/pgsql \ ../src/lib/process \ ../src/lib/stats \ ../src/lib/testutils \ diff --git a/src/bin/dhcp4/dhcp4_srv.h b/src/bin/dhcp4/dhcp4_srv.h index d2df379604..c11c33305e 100644 --- a/src/bin/dhcp4/dhcp4_srv.h +++ b/src/bin/dhcp4/dhcp4_srv.h @@ -241,7 +241,7 @@ public: } /// @brief returns Kea version on stdout and exit. - /// redeclaration/redefinition. @ref Daemon::getVersion() + /// redeclaration/redefinition. @ref isc::process::Daemon::getVersion() static std::string getVersion(bool extended); /// @brief Main server processing loop. diff --git a/src/bin/dhcp4/json_config_parser.h b/src/bin/dhcp4/json_config_parser.h index 7dc712385b..de46976409 100644 --- a/src/bin/dhcp4/json_config_parser.h +++ b/src/bin/dhcp4/json_config_parser.h @@ -1,4 +1,4 @@ -// Copyright (C) 2012-2017 Internet Systems Consortium, Inc. ("ISC") +// Copyright (C) 2012-2018 Internet Systems Consortium, Inc. ("ISC") // // This Source Code Form is subject to the terms of the Mozilla Public // License, v. 2.0. If a copy of the MPL was not distributed with this @@ -84,9 +84,9 @@ databaseConfigConnect(const SrvConfigPtr& srv_cfg); /// configuration. /// /// @param srv_cfg Server configuration into which database configuration should be merged -/// @param mutable_cfg parsed configuration from the configuration file plus default values +/// @param mutable_cfg parsed configuration from the configuration file plus default values (ignored) void -databaseConfigFetch(const SrvConfigPtr& srv_cfg, isc::data::ElementPtr /* mutable_cfg */); +databaseConfigFetch(const SrvConfigPtr& srv_cfg, isc::data::ElementPtr mutable_cfg); }; // end of isc::dhcp namespace }; // end of isc namespace diff --git a/src/bin/dhcp6/dhcp6_srv.h b/src/bin/dhcp6/dhcp6_srv.h index 6a580e9913..0fd97b76c9 100644 --- a/src/bin/dhcp6/dhcp6_srv.h +++ b/src/bin/dhcp6/dhcp6_srv.h @@ -97,7 +97,7 @@ public: } /// @brief returns Kea version on stdout and exit. - /// redeclaration/redefinition. @ref Daemon::getVersion() + /// redeclaration/redefinition. @ref isc::process::Daemon::getVersion() static std::string getVersion(bool extended); /// @brief Returns server-identifier option. diff --git a/src/lib/cc/stamped_value.h b/src/lib/cc/stamped_value.h index d8a406fb9c..4e0a2a46c0 100644 --- a/src/lib/cc/stamped_value.h +++ b/src/lib/cc/stamped_value.h @@ -72,7 +72,7 @@ public: return (name_); } - /// @Brief Returns value as string. + /// @brief Returns value as string. std::string getValue() const { return (value_); } diff --git a/src/lib/dhcpsrv/config_backend_dhcp4.h b/src/lib/dhcpsrv/config_backend_dhcp4.h index da81f4d758..a0eef73d1d 100644 --- a/src/lib/dhcpsrv/config_backend_dhcp4.h +++ b/src/lib/dhcpsrv/config_backend_dhcp4.h @@ -121,6 +121,8 @@ public: /// @brief Retrieves single option by code and space. /// /// @param server_selector Server selector. + /// @param code Option code. + /// @param space Option space. /// @return Pointer to the retrieved option descriptor or null if /// no option was found. virtual OptionDescriptorPtr @@ -147,7 +149,7 @@ public: /// @brief Retrieves global parameter value. /// - /// @param server_selector Server selector. + /// @param selector Server selector. /// @param name Name of the global parameter to be retrieved. /// @return Value of the global parameter or null if parameter doesn't /// exist. @@ -162,6 +164,7 @@ public: /// @brief Retrieves global parameters modified after specified time. /// /// @param selector Server selector. + /// @param modification_time Modification time. /// @return Collection of modified global parameters. virtual data::StampedValueCollection getModifiedGlobalParameters4(const db::ServerSelector& selector, diff --git a/src/lib/dhcpsrv/config_backend_pool_dhcp4.h b/src/lib/dhcpsrv/config_backend_pool_dhcp4.h index 22e263eb3e..8bedb4f3fa 100644 --- a/src/lib/dhcpsrv/config_backend_pool_dhcp4.h +++ b/src/lib/dhcpsrv/config_backend_pool_dhcp4.h @@ -142,6 +142,8 @@ public: /// /// @param backend_selector Backend selector. /// @param server_selector Server selector. + /// @param code Option code. + /// @param space Option space. /// @return Pointer to the retrieved option descriptor or null if /// no option was found. virtual OptionDescriptorPtr @@ -287,7 +289,6 @@ public: /// /// @param backend_selector Backend selector. /// @param server_selector Server selector. - /// @param name Name of the global parameter. /// @param value Value of the global parameter. virtual void createUpdateGlobalParameter4(const db::BackendSelector& backend_selector, diff --git a/src/lib/eval/token.h b/src/lib/eval/token.h index 0d9472e54d..2978cdc53b 100644 --- a/src/lib/eval/token.h +++ b/src/lib/eval/token.h @@ -754,7 +754,7 @@ public: /// means no separator. /// /// The following example use a binary MAC address 06:ce:8f:55:b3:33: - /// - , '-' => "06-ce-8f-55-b3-33" + /// - mac, '-' => "06-ce-8f-55-b3-33" /// /// @throw EvalBadStack if there are less than 2 values on stack /// diff --git a/src/lib/process/d_cfg_mgr.h b/src/lib/process/d_cfg_mgr.h index 7242908fad..c341f988aa 100644 --- a/src/lib/process/d_cfg_mgr.h +++ b/src/lib/process/d_cfg_mgr.h @@ -118,7 +118,7 @@ public: /// @brief Acts as the receiver of new configurations. /// - /// This method is similar to what @ref parseConfig does, execept it employs + /// This method is similar to what parseConfig did, execept it employs /// the simple parser paradigm: no intermediate storage, no parser pointers /// no distinction between params_map and objects_map, parse order (if needed) /// can be enforced in the actual implementation by calling specific diff --git a/src/lib/process/d_controller.h b/src/lib/process/d_controller.h index a9e4391013..ed6bd67e9d 100644 --- a/src/lib/process/d_controller.h +++ b/src/lib/process/d_controller.h @@ -114,7 +114,7 @@ public: virtual ~DControllerBase(); /// @brief returns Kea version on stdout and exit. - /// redeclaration/redefinition. @ref isc::dhcp::Daemon::getVersion() + /// redeclaration/redefinition. @ref isc::process::Daemon::getVersion() std::string getVersion(bool extended); /// @brief Acts as the primary entry point into the controller execution