Browse Source

[2365] Added todo comments for added functions.

Marcin Siodelski 12 years ago
parent
commit
31b4c8a77f
1 changed files with 10 additions and 0 deletions
  1. 10 0
      src/lib/dhcp/option.h

+ 10 - 0
src/lib/dhcp/option.h

@@ -320,6 +320,11 @@ protected:
     /// derived classes that override pack.
     ///
     /// @param [out] buf output buffer.
+    ///
+    /// @todo The set of exceptions thrown by this function depend on
+    /// exceptions thrown by pack methods invoked on objects
+    /// representing sub options. We should consider whether to aggregate
+    /// those into one exception which can be documented here.
     void packOptions(isc::util::OutputBuffer& buf);
 
     /// @brief Builds a collection of sub options from the buffer.
@@ -329,6 +334,11 @@ protected:
     /// different exceptions when option assembly fails.
     ///
     /// @param buf buffer to be parsed.
+    ///
+    /// @todo The set of exceptions thrown by this function depend on
+    /// exceptions thrown by unpack methods invoked on objects
+    /// representing sub options. We should consider whether to aggregate
+    /// those into one exception which can be documented here.
     void unpackOptions(const OptionBuffer& buf);
 
     /// @brief A private method used for option correctness.