Browse Source

[2318] Minor changes in comments, suggested in the code review.

Marcin Siodelski 12 years ago
parent
commit
c4159fc5c7
2 changed files with 11 additions and 0 deletions
  1. 9 0
      src/bin/dhcp6/config_parser.cc
  2. 2 0
      src/bin/dhcp6/dhcp6.dox

+ 9 - 0
src/bin/dhcp6/config_parser.cc

@@ -142,6 +142,9 @@ protected:
 ///
 /// For overview of usability of this generic purpose parser, see
 /// \ref dhcpv6-config-inherit page.
+///
+/// @todo this class should be turned into the template class which
+/// will handle all uintX_types of data (see ticket #2415).
 class Uint32Parser : public DhcpConfigParser {
 public:
 
@@ -484,6 +487,12 @@ protected:
 /// and data carried by the option. If parsing is successful than
 /// instance of an option is created and added to the storage provided
 /// by the calling class.
+///
+/// @todo This class parses and validates option name. However it is
+/// not used anywhere util support for option spaces is implemented
+/// (see tickets #2319, #2314). When option spaces are implemented
+/// there will be a way to reference the particular option using
+/// its type (code) or option name.
 class OptionDataParser : public DhcpConfigParser {
 public:
 

+ 2 - 0
src/bin/dhcp6/dhcp6.dox

@@ -76,4 +76,6 @@
  simple as possible. In fact, currently the code has to call Subnet6->getT1() and
  do not implement any fancy inheritance logic.
 
+ @todo Add section about setting up options and their definitions with bindctl.
+
  */