Browse Source

[2315] Fixed issues in doxygen documentation.

Marcin Siodelski 12 years ago
parent
commit
bf592d0607
3 changed files with 5 additions and 2 deletions
  1. 1 1
      src/lib/dhcp/option_definition.h
  2. 1 0
      src/lib/dhcpsrv/cfgmgr.h
  3. 3 1
      src/lib/dhcpsrv/subnet.h

+ 1 - 1
src/lib/dhcp/option_definition.h

@@ -369,7 +369,7 @@ public:
 
 
     /// @brief Factory function to create option with array of integer values.
     /// @brief Factory function to create option with array of integer values.
     ///
     ///
-    /// @param universe (V4 or V6).
+    /// @param u universe (V4 or V6).
     /// @param type option type.
     /// @param type option type.
     /// @param begin iterator pointing to the beginning of the buffer.
     /// @param begin iterator pointing to the beginning of the buffer.
     /// @param end iterator pointing to the end of the buffer.
     /// @param end iterator pointing to the end of the buffer.

+ 1 - 0
src/lib/dhcpsrv/cfgmgr.h

@@ -81,6 +81,7 @@ public:
     /// @brief Add new option definition.
     /// @brief Add new option definition.
     ///
     ///
     /// @param def option definition to be added.
     /// @param def option definition to be added.
+    /// @param option_space name of the option space to add definition to.
     ///
     ///
     /// @throw isc::dhcp::DuplicateOptionDefinition when the particular
     /// @throw isc::dhcp::DuplicateOptionDefinition when the particular
     /// option definition already exists.
     /// option definition already exists.

+ 3 - 1
src/lib/dhcpsrv/subnet.h

@@ -216,6 +216,7 @@ public:
     /// @param option option instance.
     /// @param option option instance.
     /// @param persistent if true, send an option regardless if client
     /// @param persistent if true, send an option regardless if client
     /// requested it or not.
     /// requested it or not.
+    /// @param option_space name of the option space to add an option to.
     ///
     ///
     /// @throw isc::BadValue if invalid option provided.
     /// @throw isc::BadValue if invalid option provided.
     void addOption(OptionPtr& option, bool persistent,
     void addOption(OptionPtr& option, bool persistent,
@@ -255,7 +256,7 @@ public:
 
 
     /// @brief Return a collection of option descriptors.
     /// @brief Return a collection of option descriptors.
     ///
     ///
-    /// @param option_space name of the option space
+    /// @param option_space name of the option space.
     ///
     ///
     /// @return reference to collection of options configured for a subnet.
     /// @return reference to collection of options configured for a subnet.
     /// The returned reference is valid as long as the Subnet object which
     /// The returned reference is valid as long as the Subnet object which
@@ -265,6 +266,7 @@ public:
     /// @brief Return single option descriptor.
     /// @brief Return single option descriptor.
     ///
     ///
     /// @param option_space name of the option space.
     /// @param option_space name of the option space.
+    /// @param option_code code of the option to be returned.
     ///
     ///
     /// @return option descriptor found for the specified option space
     /// @return option descriptor found for the specified option space
     /// and option code.
     /// and option code.