[#3280] Fixed doxygen commentary errors

Removed failing references to private class members,
Added missing paramters
miscellaneous other errors

diff --git a/src/bin/dhcp6/dhcp6.dox b/src/bin/dhcp6/dhcp6.dox
index d5752289e369d308850e174a3f0126faef3890a9..93fe100342845e7c6d4df429622e0c568255f412 100644 (file)
--- a/src/bin/dhcp6/dhcp6.dox
+++ b/src/bin/dhcp6/dhcp6.dox
@@ -544,8 +544,8 @@ and can be retrieved from CfgMgr using isc::dhcp::SrvConfig::getClientClassDicti
 This is convenient as there are often multiple classes associated with a given scope.
 
 Client classification is done in isc::dhcp::Dhcpv6Srv::classifyPacket. First, the old
-"built-in" (see @ref dhcpv6ClassifierSimple) classification is called (see @ref
-isc::dhcp::Dhcpv6Srv::classifyByVendor). Then the code iterates over all class definitions
+"built-in" (see @ref dhcpv6ClassifierSimple) classification is called (see private
+isc::dhcp::Dhcpv6Srv::classifyByVendor()). Then the code iterates over all class definitions
 and for each class definition it calls isc::dhcp::evaluate, which is implemented in libeval
 (see @ref libeval). If the evaluation is successful, the class name is added to the packet
 (by calling isc::dhcp::pkt::addClass).

diff --git a/src/bin/dhcp6/dhcp6_srv.h b/src/bin/dhcp6/dhcp6_srv.h
index d8e7a0bd3afeacfcf0eea3462056f03fdb171131..7a9331bb931f39143508c47d560423e4c7223cc5 100644 (file)
--- a/src/bin/dhcp6/dhcp6_srv.h
+++ b/src/bin/dhcp6/dhcp6_srv.h
@@ -856,7 +856,7 @@ protected:
     ///
     /// @note This is done in two phases: first the content of the
     /// vendor-class-identifier options are used as classes, by
-    /// calling @ref classifyByVendor(). Second, the classification match
+    /// calling (private) classifyByVendor. Second, the classification match
     /// expressions are evaluated. The resulting classes will be stored
     /// in the packet (see @ref isc::dhcp::Pkt6::classes_ and
     /// @ref isc::dhcp::Pkt6::inClass).

diff --git a/src/hooks/dhcp/lease_cmds/lease_cmds.dox b/src/hooks/dhcp/lease_cmds/lease_cmds.dox
index 96e2f862ce4de79c3058f80cf0a0c9ca113aad2b..e99ec12475175ea90d638d31b9f0315b90bd666b 100644 (file)
--- a/src/hooks/dhcp/lease_cmds/lease_cmds.dox
+++ b/src/hooks/dhcp/lease_cmds/lease_cmds.dox
@@ -60,15 +60,23 @@ class that contains parsed elements.
 
 For details see documentation and code of the following handlers:
 - @ref isc::lease_cmds::LeaseCmdsImpl::leaseAddHandler (lease4-add, lease6-add)
+- @ref isc::lease_cmds::LeaseCmdsImpl::lease6BulkApplyHandler(lease6-bulk-apply)
 - @ref isc::lease_cmds::LeaseCmdsImpl::leaseGetHandler (lease4-get, lease6-get)
+- @ref isc::lease_cmds::LeaseCmdsImpl::leaseGetAllHandler(lease4-get-all, lease6-get-all)
+- @ref isc::lease_cmds::LeaseCmdsImpl::leaseGetPageHandler(lease4-get-page, lease6-get-page)
+- @ref isc::lease_cmds::LeaseCmdsImpl::leaseGetByHwAddressHandler(lease4-get-by-hw-address)
+- @ref isc::lease_cmds::LeaseCmdsImpl::leaseGetByClientIdHandler(lease4-get-by-client-id)
+- @ref isc::lease_cmds::LeaseCmdsImpl::leaseGetByDuidHandler(lease6-get-by-duid)
+- @ref isc::lease_cmds::LeaseCmdsImpl::leaseGetByHostnameHandler(lease4-get-by-hostname, lease6-get-by-hostname)
 - @ref isc::lease_cmds::LeaseCmdsImpl::lease4DelHandler (lease4-del)
 - @ref isc::lease_cmds::LeaseCmdsImpl::lease6DelHandler (lease6-del)
 - @ref isc::lease_cmds::LeaseCmdsImpl::lease4UpdateHandler (lease4-update)
 - @ref isc::lease_cmds::LeaseCmdsImpl::lease6UpdateHandler (lease6-update)
 - @ref isc::lease_cmds::LeaseCmdsImpl::lease4WipeHandler (lease4-wipe)
 - @ref isc::lease_cmds::LeaseCmdsImpl::lease6WipeHandler (lease6-wipe)
-- @ref isc::lease_cmds::LeaseCmdsImpl::lease4WriteHandler (lease4-write)
-- @ref isc::lease_cmds::LeaseCmdsImpl::lease6WriteHandler (lease6-write)
+- @ref isc::lease_cmds::LeaseCmdsImpl::lease4ResendDdnsHandler(lease4-resend-ddns)
+- @ref isc::lease_cmds::LeaseCmdsImpl::lease6ResendDdnsHandler(lease6-resend-ddns)
+- @ref isc::lease_cmds::LeaseCmdsImpl::leaseWriteHandler (lease4-write, lease6-write)
 
 @section lease_cmdsDesigns Lease Commands Design choices
 

diff --git a/src/lib/asiolink/process_spawn.cc b/src/lib/asiolink/process_spawn.cc
index 36c618c328be9fdccde532109a32a0c84ade83be..ec40fdf837f89883d6099ffed9c0ca65b793557d 100644 (file)
--- a/src/lib/asiolink/process_spawn.cc
+++ b/src/lib/asiolink/process_spawn.cc
@@ -83,6 +83,8 @@ public:
     /// @param vars Environment variables for the program to be executed.
     /// @param inherit_env whether the spawned process will inherit the
     ///        environment before adding 'vars' on top.
+    /// @param sync enables syncrhonous mode (spawning thread waits on
+    /// child to cmplete if true)
     ProcessSpawnImpl(IOServicePtr io_service,
                      const std::string& executable,
                      const ProcessArgs& args,

diff --git a/src/lib/cc/command_interpreter.h b/src/lib/cc/command_interpreter.h
index f834f344d560cf51db40584b4deb23a4e30ac794..64d9d700d6ea559e6b2f2cd39f65a13abb918526 100644 (file)
--- a/src/lib/cc/command_interpreter.h
+++ b/src/lib/cc/command_interpreter.h
@@ -118,7 +118,7 @@ parseAnswer(int &status_code, const isc::data::ConstElementPtr& msg);
 /// This method returns the text status. If you need to get the arguments provided,
 /// please use @ref parseAnswer.
 ///
-/// @param status_code This value will be set to the return code contained in
+/// @param rcode This value will be set to the return code contained in
 ///              the message
 /// @param msg The message to parse
 /// @return The optional argument in the message (or null)

diff --git a/src/lib/dhcp/iface_mgr.h b/src/lib/dhcp/iface_mgr.h
index d1956e5005c6df1be64212c80e4728d0489fe96c..5fc577a0d7ba45d036e7e6937852c6ffe9def528 100644 (file)
--- a/src/lib/dhcp/iface_mgr.h
+++ b/src/lib/dhcp/iface_mgr.h
@@ -826,7 +826,7 @@ public:
 
     /// @brief Detects network interfaces.
     ///
-    /// If the @ref detect_callback_ returns true, the specific system calls are
+    /// If the detect callback returns true, the specific system calls are
     /// executed, otherwise the @ref detectIfaces will return immediately.
     ///
     /// @param update_only Only add interfaces that do not exist and update
@@ -1618,7 +1618,7 @@ private:
     /// @brief Detect callback used to perform actions before system dependent
     /// function calls.
     ///
-    /// If the @ref detect_callback_ returns true, the specific system calls are
+    /// If this call back returns true, the specific system calls are
     /// executed, otherwise the @ref detectIfaces will return immediately.
     DetectCallback detect_callback_;
 

diff --git a/src/lib/dhcp/option_vendor_class.h b/src/lib/dhcp/option_vendor_class.h
index d0bc1480a3b555804e33e94dc444ae1b4aa265e1..9de8484f94848f4bbebca3f58d86b495ef96b539 100644 (file)
--- a/src/lib/dhcp/option_vendor_class.h
+++ b/src/lib/dhcp/option_vendor_class.h
@@ -36,7 +36,7 @@ namespace dhcp {
 /// Vendor Class option is controlled by the @c u (universe) parameter passed
 /// to the constructor.
 ///
-/// @Currently, the enterprise id field is set to a value of the first
+/// Currently, the enterprise id field is set to a value of the first
 /// enterprise id occurrence in the parsed option. This assumes that
 /// all tuples in the same option are for the same vendor.
 class OptionVendorClass : public Option {

diff --git a/src/lib/dhcp/pkt.cc b/src/lib/dhcp/pkt.cc
index 4f55fb5e6a5d338cdce4cd018f01c1b690e1bdfb..195480db5840e62c96f0466e1c07b5e1fdf039cd 100644 (file)
--- a/src/lib/dhcp/pkt.cc
+++ b/src/lib/dhcp/pkt.cc
@@ -318,7 +318,7 @@ Pkt::getMACFromIPv6(const isc::asiolink::IOAddress& addr) {
 
 
 void
-Pkt::addPktEvent(const std::string& label, const ptime& timestamp) {
+Pkt::addPktEvent(const std::string& label, const boost::posix_time::ptime& timestamp) {
     events_.push_back(PktEvent(label, timestamp));
 }
 

diff --git a/src/lib/dhcp_ddns/ncr_msg.h b/src/lib/dhcp_ddns/ncr_msg.h
index 1c942501226bf9f6d9c5e9e4ef82666b61f5597c..7c332d53666b949a313d6816a805f7cecbd193dd 100644 (file)
--- a/src/lib/dhcp_ddns/ncr_msg.h
+++ b/src/lib/dhcp_ddns/ncr_msg.h
@@ -41,7 +41,6 @@ public:
         isc::Exception(file, line, what) { };
 };
 
-
 /// @brief Defines the types of DNS updates that can be requested.
 enum NameChangeType {
   CHG_ADD,
@@ -90,7 +89,7 @@ extern std::string ncrFormatToString(NameChangeFormat format);
 
 /// @brief Function which converts string to ConflictResolutionMode enum values.
 ///
-/// @param fmt_str text to convert to an enum.
+/// @param mode_str text to convert to an enum.
 /// Valid string values: "check-with-dhcid", "no-check-with-dhcid",
 ///                      "check-exists-with-dhcid", "no-check-without-dhcid"
 ///
@@ -102,7 +101,7 @@ ConflictResolutionMode StringToConflictResolutionMode(const std::string& mode_st
 
 /// @brief Function which converts ConflictResolutionMode enums to text labels.
 ///
-/// @param format enum value to convert to label
+/// @param mode ConflictResolutionMode enum value to convert to string.
 ///
 /// @return std:string containing the text label if the value is valid, or
 /// "unknown" if not.

diff --git a/src/lib/dhcpsrv/client_class_def.h b/src/lib/dhcpsrv/client_class_def.h
index a5f513942f6aac94d92a339c4eae5bfbce579860..da5a452e562891e3a284a567ab1e95489f32f862 100644 (file)
--- a/src/lib/dhcpsrv/client_class_def.h
+++ b/src/lib/dhcpsrv/client_class_def.h
@@ -241,6 +241,7 @@ public:
     /// If the packet belongs to the class, the class is added to the packet.
     ///
     /// @param pkt The packet checked if it belongs to the class.
+    /// @param expr_ptr Expression the class will use to determine membership
     virtual void test(PktPtr pkt, const ExpressionPtr& expr_ptr);
 
     /// @brief Unparse a configuration object
@@ -324,6 +325,7 @@ public:
     /// If the packet belongs to the class, the class is added to the packet.
     ///
     /// @param pkt The packet checked if it belongs to the class.
+    /// @param expr_ptr Expression the class will use to determine membership
     virtual void test(PktPtr pkt, const ExpressionPtr& expr_ptr) override;
 
     /// @brief Unparse a configuration object
@@ -383,6 +385,8 @@ public:
     /// @param filename boot-file-name value for this class (optional)
     /// @param valid valid-lifetime triplet (optional)
     /// @param preferred preferred-lifetime triplet (optional)
+    /// @param is_template true if class is a template class. Defaults to false.
+    /// @param offer_lft the offer lifetime assigned to the class (may be empty if not defined)
     ///
     /// @throw DuplicateClientClassDef if class already exists within the
     /// dictionary.  See @ref dhcp::ClientClassDef::ClientClassDef() for

diff --git a/src/lib/dhcpsrv/network.h b/src/lib/dhcpsrv/network.h
index 92396e295137cce7c4e7c195e04ceb05cc42133d..2b7b31b26a345973db29a4c929638dc4faa4631c 100644 (file)
--- a/src/lib/dhcpsrv/network.h
+++ b/src/lib/dhcpsrv/network.h
@@ -793,7 +793,7 @@ public:
 
     /// @brief Sets new ib-ddns-conflict-resolution-mode
     ///
-    /// @param ddns_use_conflict_resolution New value to use.
+    /// @param ddns_conflict_resolution_mode New value to use.
     void setDdnsConflictResolutionMode(const util::Optional<std::string>& ddns_conflict_resolution_mode) {
         ddns_conflict_resolution_mode_ = ddns_conflict_resolution_mode;
     }

diff --git a/src/lib/dhcpsrv/parsers/dhcp_parsers.h b/src/lib/dhcpsrv/parsers/dhcp_parsers.h
index 8ea870ffc97544f926523475c12e19378ac17888..e9d918acc4361039089d152885633224cf828abe 100644 (file)
--- a/src/lib/dhcpsrv/parsers/dhcp_parsers.h
+++ b/src/lib/dhcpsrv/parsers/dhcp_parsers.h
@@ -973,6 +973,7 @@ public:
     /// @param subnets_list pointer to a list of IPv6 subnets
     /// @param encapsulate_options a boolean parameter indicating if the
     /// parsed options should be encapsulated with suboptions.
+
     /// @throw DhcpConfigError if CfgMgr rejects the subnet (e.g. subnet-id is a duplicate)
     size_t parse(SrvConfigPtr cfg, data::ConstElementPtr subnets_list,
                  bool encapsulate_options = true);
@@ -981,6 +982,9 @@ public:
     ///
     /// @param [out] subnets Container where parsed subnets will be stored.
     /// @param subnets_list pointer to a list of IPv6 subnets
+    /// @param encapsulate_options a boolean parameter indicating if the
+    /// parsed options should be encapsulated with suboptions.
+    ///
     /// @return Number of subnets created.
     size_t parse(Subnet6Collection& subnets,
                  data::ConstElementPtr subnets_list,

diff --git a/src/lib/mysql/mysql_connection.h b/src/lib/mysql/mysql_connection.h
index 3d17235a110652826e3c9ef4ee774587877da54f..10dc1dc1f4bdb5bec1e1a0f79f2d65fec7a8fe01 100644 (file)
--- a/src/lib/mysql/mysql_connection.h
+++ b/src/lib/mysql/mysql_connection.h
@@ -291,6 +291,8 @@ public:
     ///
     /// @param parameters A data structure relating keywords and values
     ///     concerned with the database.
+    /// @param cb The dbReconnect callback.
+    /// @param timer_name The DB reconnect timer name.
     ///
     /// @throw isc::db::ScehamInitializationFailed if the initialization fails
     static void

diff --git a/src/lib/pgsql/pgsql_connection.h b/src/lib/pgsql/pgsql_connection.h
index e11d388b246e5e38282bd55c5db0cb5f88eac1d4..6290b1ec0950195a04336d2b90d8f0e524fb8528 100644 (file)
--- a/src/lib/pgsql/pgsql_connection.h
+++ b/src/lib/pgsql/pgsql_connection.h
@@ -262,6 +262,8 @@ public:
     ///
     /// @param parameters A data structure relating keywords and values
     ///     concerned with the database.
+    /// @param cb The dbReconnect callback.
+    /// @param timer_name The DB reconnect timer name.
     ///
     /// @throw isc::db::ScehamInitializationFailed if the initialization fails
     static void

diff --git a/src/lib/testutils/gtest_utils.h b/src/lib/testutils/gtest_utils.h
index 6bb267e22cb793299ad65126f06f7309fabfaf47..2a58f898e6f29b7b75b3036d920e6c90bc1e670a 100644 (file)
--- a/src/lib/testutils/gtest_utils.h
+++ b/src/lib/testutils/gtest_utils.h
@@ -92,7 +92,7 @@ namespace test {
 /// if the given expression is true.  This works around the lack of
 /// GTEST_SKIP prior to googletest 1.10.
 ///
-/// @note  This macro cannot be used in ::testing::Test::SetUp()
+/// @note  This macro cannot be used in testing::Test::SetUp()
 /// to skip tests (unless running with googletest 1.10 or later).
 /// It must be used directly within the body of each unit test.
 ///

diff --git a/src/lib/testutils/lib_load_test_fixture.h b/src/lib/testutils/lib_load_test_fixture.h
index 182d0ef7aeab777498a34cb6c821fc079e95ac57..4ff282053d4171d5f29ead645e84eb718e853ad4 100644 (file)
--- a/src/lib/testutils/lib_load_test_fixture.h
+++ b/src/lib/testutils/lib_load_test_fixture.h
@@ -20,7 +20,7 @@ class LibLoadTest : public ::testing::Test {
 public:
     /// @brief Constructor. Unloads any previously loaded libraries.
     ///
-    /// @param lib_so_name_ full pathname to the library so file under test
+    /// @param lib_so_name full pathname to the library so file under test
     LibLoadTest(const std::string lib_so_name = "no-lib-specified")
         : lib_so_name_(lib_so_name) {
         unloadLibraries();
@@ -101,8 +101,6 @@ public:
 
     /// @brief Verifies that an invalid daemon cannot load the library.
     ///
-    /// @param libname full path to the library's SO. Typically this
-    /// value is defined in the Makefile (e.g. -DLIBDHCP_BOOTP_SO=...)
     /// @param daemon_name name of the daemon that should try to load the library
     /// @param family Protocol family of the loading daemon, either
     /// AF_INET or AF_INET6. Defaults to AF_INET.

diff --git a/src/lib/util/encode/encode.h b/src/lib/util/encode/encode.h
index 0f8933685923bc12de36f0d10567f8dd9466bfc2..379c9da9681559a66a3233ac0d6ead57a30301bc 100644 (file)
--- a/src/lib/util/encode/encode.h
+++ b/src/lib/util/encode/encode.h
@@ -20,7 +20,7 @@ namespace encode {
 class BaseNEncoder {
 public:
 
-    /// @Brief Constructor
+    /// @brief Constructor
     ///
     /// @param algorithm name of the algorithm, used for logging
     /// @param digit_set set of digits (i.e. alphabet) used for encoding
@@ -41,7 +41,7 @@ public:
                  size_t max_pad,
                  bool case_sensitive);
 
-    /// @Brief Destructor
+    /// @brief Destructor
     virtual ~BaseNEncoder() = default;
 
     /// @brief Encodes binary data using the encoder's algorithm
@@ -62,7 +62,7 @@ public:
     ///
     /// @param bits binary value to translate
     /// @return char containing the digit corresponding to the binary value
-    /// @isc_throw BadValue if the bits value is out of range
+    /// @throw BadValue if the bits value is out of range
     char bitsToDigit(uint8_t bits);
 
     /// @brief Translate a digit into the appropriate algorithm bit value