[2546] Fixed some Doxygen warnings

doc/devel/02-dhcp.dox

@@ -19,7 +19,7 @@
  *
  * @section dhcpv4Session BIND10 message queue integration
  *
- * DHCPv4 server component is now integrated with BIND10 message queue.
+ * DHCPv4 server component is now integrated with the BIND10 message queue.
  * The integration is performed by establishSession() and disconnectSession()
  * functions in isc::dhcp::ControlledDhcpv4Srv class. main() method deifined
  * in the src/bin/dhcp4/main.cc file instantiates isc::dhcp::ControlledDhcpv4Srv
@@ -57,4 +57,4 @@
  * that does not support msgq. That is useful for embedded environments.
  * It may also be useful in validation.
  *
- */
\ No newline at end of file
+ */

doc/devel/mainpage.dox

@@ -23,9 +23,9 @@
  * - @subpage dhcpv4
  *   - @subpage dhcpv4Session
  * - @subpage dhcpv6
- *   - @subpage dhcpv6-session
- *   - @subpage dhcpv6-config-parser
- *   - @subpage dhcpv6-config-inherit
+ *   - @subpage dhcpv6Session
+ *   - @subpage dhcpv6ConfigParser
+ *   - @subpage dhcpv6ConfigInherit
  * - @subpage libdhcp
  *   - @subpage libdhcpIntro
  *   - @subpage libdhcpIfaceMgr

src/bin/dhcp4/ctrl_dhcp4_srv.h

@@ -66,8 +66,8 @@ public:
 
     /// @brief Session callback, processes received commands.
     ///
-    /// @param command_id text represenation of the command (e.g. "shutdown")
-    /// @param args optional parameters
+    /// @param command Text represenation of the command (e.g. "shutdown")
+    /// @param args Optional parameters
     ///
     /// @return status of the command
     static isc::data::ConstElementPtr

src/bin/dhcp4/dhcp4_srv.h

@@ -36,7 +36,7 @@ namespace dhcp {
 /// appropriate responses.
 ///
 /// This class does not support any controlling mechanisms directly.
-/// See derived \ref ControlledDhcv4Srv class for support for
+/// See the derived \ref ControlledDhcpv4Srv class for support for
 /// command and configuration updates over msgq.
 ///
 /// For detailed explanation or relations between main(), ControlledDhcpv4Srv,

src/bin/dhcp6/config_parser.cc

@@ -339,7 +339,7 @@ public:
     /// @brief parses parameters value
     ///
     /// Parses configuration entry (list of parameters) and stores it in
-    /// storage. See \ref setStorage() for details.
+    /// storage.
     ///
     /// @param value pointer to the content of parsed values
     virtual void build(ConstElementPtr value) {

src/bin/dhcp6/ctrl_dhcp6_srv.cc

@@ -17,7 +17,6 @@
 #include <asiolink/asiolink.h>
 #include <cc/data.h>
 #include <cc/session.h>
-#include <cc/session.h>
 #include <config/ccsession.h>
 #include <dhcp/iface_mgr.h>
 #include <dhcp6/config_parser.h>

src/bin/dhcp6/ctrl_dhcp6_srv.h

@@ -68,8 +68,8 @@ public:
 
     /// @brief Session callback, processes received commands.
     ///
-    /// @param command_id text represenation of the command (e.g. "shutdown")
-    /// @param args optional parameters
+    /// @param command Text represenation of the command (e.g. "shutdown")
+    /// @param args Optional parameters
     ///
     /// @return status of the command
     static isc::data::ConstElementPtr

src/bin/dhcp6/dhcp6.dox

@@ -16,13 +16,13 @@
 
  DHCPv6 server component does not use BIND10 logging yet.
 
- @section dhcpv6-session BIND10 message queue integration
+ @section dhcpv6Session BIND10 message queue integration
 
  DHCPv4 server component is now integrated with BIND10 message queue.
  It follows the same principle as DHCPv4. See \ref dhcpv4Session for
  details.
 
- @section dhcpv6-config-parser Configuration Parser in DHCPv6
+ @section dhcpv6ConfigParser Configuration Parser in DHCPv6
 
  b10-dhcp6 component uses BIND10 cfgmgr for commands and configuration. During
  initial configuration (See \ref
@@ -49,7 +49,7 @@
  elements and creates parsers for a given scope. This process may be repeated
  (sort of) recursively.
 
- @section dhcpv6-config-inherit DHCPv6 Configuration Inheritance
+ @section dhcpv6ConfigInherit DHCPv6 Configuration Inheritance
 
  One notable useful feature of DHCP configuration is its parameter inheritance.
  For example, renew-timer value may be specified at a global scope and it then

src/lib/dhcp/pkt4.h

@@ -525,7 +525,7 @@ protected:
 
     /// collection of options present in this message
     ///
-    /// @warnig This protected member is accessed by derived
+    /// @warning This protected member is accessed by derived
     /// classes directly. One of such derived classes is
     /// @ref perfdhcp::PerfPkt4. The impact on derived clasess'
     /// behavior must be taken into consideration before making

src/lib/dhcpsrv/addr_utilities.h

@@ -26,8 +26,8 @@ namespace dhcp {
 
 /// @brief returns a first address in a given prefix
 ///
-/// Example: For 2001:db8:1::deaf:beef and length /120 the function will return
-/// 2001:db8:1::dead:be00. See also @ref lastAddrInPrefix.
+/// Example: For 2001:db8:1\::deaf:beef and length /120 the function will return
+/// 2001:db8:1\::dead:be00. See also @ref lastAddrInPrefix.
 ///
 /// @todo It currently works for v6 only and will throw if v4 address is passed.
 ///
@@ -40,8 +40,8 @@ isc::asiolink::IOAddress firstAddrInPrefix(const isc::asiolink::IOAddress& prefi
 
 /// @brief returns a last address in a given prefix
 ///
-/// Example: For 2001:db8:1::deaf:beef and length /112 the function will return
-/// 2001:db8:1::dead:ffff. See also @ref firstAddrInPrefix.
+/// Example: For 2001:db8:1\::deaf:beef and length /112 the function will return
+/// 2001:db8:1\::dead:ffff. See also @ref firstAddrInPrefix.
 ///
 /// @todo It currently works for v6 only and will throw if v4 address is passed.
 ///

src/lib/dhcpsrv/cfgmgr.h

@@ -43,6 +43,7 @@ namespace dhcp {
 /// Below is a sketch of configuration inheritance (not implemented yet).
 /// Let's investigate the following configuration:
 ///
+/// @code
 /// preferred-lifetime 500;
 /// valid-lifetime 1000;
 /// subnet6 2001:db8:1::/48 {
@@ -52,6 +53,8 @@ namespace dhcp {
 ///     valid-lifetime 2000;
 ///     pool6 2001::db8:2::1 - 2001::db8:2::ff;
 /// };
+/// @endcode
+///
 /// Parameters defined in a global scope are applicable to everything until
 /// they are overwritten in a smaller scope, in this case subnet6.
 /// In the example above, the first subnet6 has preferred lifetime of 500s

src/lib/dhcpsrv/lease_mgr.h

@@ -30,7 +30,7 @@
 #include <utility>
 #include <vector>
 
-/// @file dhcp/lease_mgr.h
+/// @file lease_mgr.h
 /// @brief An abstract API for lease database
 ///
 /// This file contains declarations of Lease4, Lease6 and LeaseMgr classes.