[#3793] Fixed doxygen

diff --git a/src/bin/dhcp6/dhcp6_hooks.dox b/src/bin/dhcp6/dhcp6_hooks.dox
index 0af45eb90ecc56b1bc006b86c3e02fe04594512f..3dca3eb908544f11add4d1cff49ac8e3dca5dfed 100644 (file)
--- a/src/bin/dhcp6/dhcp6_hooks.dox
+++ b/src/bin/dhcp6/dhcp6_hooks.dox
@@ -352,7 +352,7 @@ called before "subnet6_select".
   - name: @b response6, type: isc::dhcp::Pkt6Ptr, direction: <b>in</b>
   - name: @b address6, type: isc::asiolink::IOAddress, direction: <b>in</b>
   - name: @b old_lease6, type: isc::dhcp::Lease6Ptr, direction: <b>in</b>
-  - name: @b new_lease6, type: isc::dhcp::Lease6Ptr, direction: <b>in<b>
+  - name: @b new_lease6, type: isc::dhcp::Lease6Ptr, direction: <b>in</b>
 
  - @b Description: this callout is executed when an addr-reg-inform was
    received and successfully processed but before the lease operation which

diff --git a/src/lib/dhcp/pkt4.h b/src/lib/dhcp/pkt4.h
index 373db03299a28f87b6a4ddbdf8407d7da5881607..af7318fc7d53a7ea837602a94650fad2f4725022 100644 (file)
--- a/src/lib/dhcp/pkt4.h
+++ b/src/lib/dhcp/pkt4.h
@@ -334,7 +334,7 @@ public:
     /// @brief Add an option.
     ///
     /// @note: to avoid throwing when adding multiple options
-    /// with the same type use @ref Pkt::addOption.
+    /// with the same type use @ref isc::dhcp::Pkt::addOption.
     ///
     /// @throw BadValue if option with that type is already present.
     ///

diff --git a/src/lib/dhcpsrv/legal_log_mgr.h b/src/lib/dhcpsrv/legal_log_mgr.h
index 6abeb3fe645cb0dd849606a93de432649c87b3fd..4870202a1ba163e0b4277e6f5639b5c1c68a4c75 100644 (file)
--- a/src/lib/dhcpsrv/legal_log_mgr.h
+++ b/src/lib/dhcpsrv/legal_log_mgr.h
@@ -75,12 +75,14 @@ public:
     /// consistent.
     ///
     /// @param parameters The library parameters.
+    /// @param [out] map The parameter map.
     static void parseFile(const isc::data::ConstElementPtr& parameters, isc::db::DatabaseConnection::ParameterMap& map);
 
     /// @brief Parse extra parameters which are not related to backend
     /// connection.
     ///
     /// @param parameters The library parameters.
+    /// @param [out] map The parameter map.
     static void parseExtraParameters(const isc::data::ConstElementPtr& parameters, isc::db::DatabaseConnection::ParameterMap& map);
 
     /// @brief Opens the store.
@@ -211,9 +213,10 @@ public:
 
     /// @brief Sets the timestamp format used for logging.
     ///
-    /// @param format Desired format for the string. Permissible formatting is
-    /// the one supported by strftime plus the '%Q' extra format which adds the
-    /// microseconds subunits. The default is: "%Y-%m-%d %H:%M:%S %Z".
+    /// @param timestamp_format Desired format for the string.
+    /// Permissible formatting is the one supported by strftime plus
+    /// the '%Q' extra format which adds the microseconds subunits.
+    /// The default is: "%Y-%m-%d %H:%M:%S %Z".
     void setTimestampFormat(const std::string& timestamp_format);
 
     /// @brief Gets the timestamp format used for logging.
@@ -238,7 +241,7 @@ public:
     ///
     /// Sets the backend parameters
     ///
-    /// @param parameter Parameters of the backend.
+    /// @param parameters Parameters of the backend.
     virtual void setParameters(isc::db::DatabaseConnection::ParameterMap parameters) {
         parameters_ = parameters;
     }

diff --git a/src/lib/dhcpsrv/legal_log_mgr_factory.h b/src/lib/dhcpsrv/legal_log_mgr_factory.h
index 8a0722eb89e94ec54bee81bc73a19f4a84d20f55..46eb1b64031fa6079034854a49f6cde4fc3c61a2 100644 (file)
--- a/src/lib/dhcpsrv/legal_log_mgr_factory.h
+++ b/src/lib/dhcpsrv/legal_log_mgr_factory.h
@@ -111,9 +111,9 @@ public:
 
     /// @brief Gets the forensic backend manager parameters.
     ///
-    /// @param parameters database parameters.
     /// @param id the forensic backend manager ID
     /// (default value is 0 and it is used only in unit tests).
+    /// @return database parameters.
     static isc::db::DatabaseConnection::ParameterMap getParameters(ManagerID id = 0);
 
     /// @brief Delete a forensic backend manager.

diff --git a/src/lib/dhcpsrv/libdhcpsrv.dox b/src/lib/dhcpsrv/libdhcpsrv.dox
index 46f03028940749c7c417ae016da96071c59d9dcc..640260d6c2593ddee5146fd39c691fab91de9c75 100644 (file)
--- a/src/lib/dhcpsrv/libdhcpsrv.dox
+++ b/src/lib/dhcpsrv/libdhcpsrv.dox
@@ -86,12 +86,6 @@ marks the staging object as "current configuration". The const pointer to the
 current configuration can be accessed by calling a
 \ref isc::dhcp::CfgMgr::getCurrentCfg.
 
-The staging configuration can be discarded at any time before it is committed
-by calling the \ref isc::dhcp::CfgMgr::rollback. This removes the
-\ref isc::dhcp::SrvConfig object from the Configuration Manager. When
-the \ref isc::dhcp::CfgMgr::getStagingCfg is called again a fresh/default
-\ref isc::dhcp::SrvConfig object is returned.
-
 The Configuration Manager stores previous configurations, i.e. configurations
 which occurred prior to the most current configuration. This is currently
 unused (except for unit tests) by the daemons, but in the future this