]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[180-address-some-doxygen-warnings-errors] Saved tentative fixes
authorFrancis Dupont <fdupont@isc.org>
Mon, 22 Oct 2018 13:38:20 +0000 (15:38 +0200)
committerTomek Mrugalski <tomasz@isc.org>
Mon, 5 Nov 2018 06:29:11 +0000 (13:29 +0700)
doc/Doxyfile
src/bin/dhcp4/dhcp4_srv.h
src/bin/dhcp4/json_config_parser.h
src/bin/dhcp6/dhcp6_srv.h
src/lib/cc/stamped_value.h
src/lib/dhcpsrv/config_backend_dhcp4.h
src/lib/dhcpsrv/config_backend_pool_dhcp4.h
src/lib/eval/token.h
src/lib/process/d_cfg_mgr.h
src/lib/process/d_controller.h

index 29a6a49f6e648e45afef04339d46f1af516166b6..8aae92f551ecf1fb8562a542f3a119d89c6546fc 100644 (file)
@@ -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 \
index d2df379604bee34b2b06d90865667d06684d5bb3..c11c33305e4068e68288f7aeb6b87b825db48ec1 100644 (file)
@@ -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.
index 7dc712385b29ef4b4ba3a232498f54144738e413..de469764093f12e9f33d22f405bb48997af02292 100644 (file)
@@ -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
index 6a580e9913dac48c6a54d915013780de644bfe73..0fd97b76c9eee30bc1320094cb446456013de892 100644 (file)
@@ -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.
index d8a406fb9cc7d71520b53ba16ccca88dd1901ffa..4e0a2a46c0ee78998f2b0860b3494330c5b5ede8 100644 (file)
@@ -72,7 +72,7 @@ public:
         return (name_);
     }
 
-    /// @Brief Returns value as string.
+    /// @brief Returns value as string.
     std::string getValue() const {
         return (value_);
     }
index da81f4d7585fba23994dbfe12f843ded2dd00df1..a0eef73d1d22beed15838abfd6efe32dd1322e25 100644 (file)
@@ -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,
index 22e263eb3ed72f5d78a0554cbafe1482765bd2c7..8bedb4f3fab109287582c06ce22cd884e23e13f2 100644 (file)
@@ -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,
index 0d9472e54db9cd77d06fd7208e179092d4a63b5d..2978cdc53bd7b756c616d1a391812bc70e689cc1 100644 (file)
@@ -754,7 +754,7 @@ public:
     /// means no separator.
     ///
     /// The following example use a binary MAC address 06:ce:8f:55:b3:33:
-    /// - <mac>, '-' => "06-ce-8f-55-b3-33"
+    /// - mac, '-' => "06-ce-8f-55-b3-33"
     ///
     /// @throw EvalBadStack if there are less than 2 values on stack
     ///
index 7242908fad01b9e6d53f321f3d89799cf305c6ca..c341f988aa02bca471a56e406553bc5acd3cbf20 100644 (file)
@@ -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
index a9e439101316cdd5db7f5acadddc8b6747790da5..ed6bd67e9d95ed5194366a56454a2425e7fe8638 100644 (file)
@@ -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