[#3074] comments updated

diff --git a/src/lib/dhcp/option_classless_static_route.h b/src/lib/dhcp/option_classless_static_route.h
index 49a2fb231253b820198873780ecfd85b57a0c3cb..f4b5d2674f3c3c3a75655829a3671dcbd7956a96 100644 (file)
--- a/src/lib/dhcp/option_classless_static_route.h
+++ b/src/lib/dhcp/option_classless_static_route.h
@@ -20,21 +20,29 @@ typedef std::tuple<asiolink::IOAddress, uint8_t, asiolink::IOAddress> StaticRout
 /// @brief Represents DHCPv4 Classless Static Route %Option (code 121).
 class OptionClasslessStaticRoute : public Option {
 public:
-    /// @brief Empty Constructor
+    /// @brief Constructor of the %Option with no static routes.
+    ///
+    /// This constructor creates an instance of the option with no static routes.
+    /// Any static routes must be added after. Intended use of this ctor are unit tests.
     OptionClasslessStaticRoute()
         : Option(V4, DHO_CLASSLESS_STATIC_ROUTE), static_routes_(), data_len_(0),
           convenient_notation_(false) {
     }
 
-    /// @brief Constructor of the %Option from on-wire data.
+    /// @brief Constructor of the %Option from data in the buffer.
     ///
     /// This constructor creates an instance of the option using a buffer with
-    /// on-wire data. It may throw an exception if the @c unpack method throws.
+    /// the data. This %Option allows constructing from on-wire binary data
+    /// and also from convenient string notation which can be used in config.
+    /// To determine what is the nature of the data in buffer, @c convenient_notation
+    /// flag is used. It may throw an exception if the @c unpack method throws.
     ///
     /// @param begin Iterator pointing to the beginning of the buffer holding an
     /// option.
     /// @param end Iterator pointing to the end of the buffer holding an option.
-    /// @param convenient_notation
+    /// @param convenient_notation Flag stating whether data in buffer is a convenient
+    ///                            notation string that needs custom parsing or binary
+    ///                            data. Defaults to @c false.
     OptionClasslessStaticRoute(OptionBufferConstIter begin,
                                OptionBufferConstIter end,
                                bool convenient_notation = false);
@@ -77,6 +85,7 @@ public:
     uint16_t len() const override;
 
     /// @brief Adds static route to collection of all static routes.
+    ///
     /// @param route A tuple defining new static route
     void addRoute(const StaticRouteTuple& route);
 
@@ -87,11 +96,14 @@ private:
     /// @brief Length in octets of all encoded static routes.
     uint16_t data_len_;
 
-    /// @brief
+    /// @brief Flag stating whether the %Option was constructed with a convenient notation string,
+    /// that needs custom parsing, or binary data.
     bool convenient_notation_;
 
     /// @brief Encodes destination descriptor as per RFC3442.
+    ///
     /// @param route static route tuple
+    ///
     /// @return Contents of the destination descriptor as a vector
     /// of bytes in network-byte order.
     static std::vector<uint8_t> encodeDestinationDescriptor(const StaticRouteTuple& route);
@@ -104,6 +116,7 @@ private:
     /// width of the subnet mask divided by eight, rounding up.
     ///
     /// @param mask_width width of subnet mask
+    ///
     /// @return number of significant octets
     static uint8_t calcSignificantOctets(const uint8_t& mask_width);
 

diff --git a/src/lib/dhcp/option_definition.cc b/src/lib/dhcp/option_definition.cc
index 8e2b8403f4170d436098cd495731b319e01fe95b..17e3be1a799ea0bb0cd57dd7ade91a2dcdfd09e3 100644 (file)
--- a/src/lib/dhcp/option_definition.cc
+++ b/src/lib/dhcp/option_definition.cc
@@ -210,6 +210,8 @@ OptionDefinition::optionFactory(Option::Universe u,
             }
 
         case OPT_BINARY_TYPE:
+        // If this is Custom type, and it wasn't handled by factorySpecialFormatOption() before,
+        // let's treat it like normal Binary type.
         case OPT_CUSTOM_TYPE:
             return (factoryGeneric(u, type, begin, end));
 
@@ -311,6 +313,9 @@ OptionDefinition::optionFactory(Option::Universe u, uint16_t type,
                 isc_throw(InvalidOptionValue, "no option value specified");
             }
         } else if (type_ == OPT_CUSTOM_TYPE) {
+            // If Custom type is used together with csv-format=true, let's treat it
+            // like String type. optionFactory() will be called with custom_data flag set to true,
+            // so that the factory will have a chance to handle it in a custom way.
             writeToBuffer(u, boost::algorithm::join(values, ","), OPT_STRING_TYPE, buf);
         } else {
             writeToBuffer(u, util::str::trim(values[0]), type_, buf);

diff --git a/src/lib/dhcp/option_definition.h b/src/lib/dhcp/option_definition.h
index 041c44bf61d03c83f22d5171c85ab3f6498f7f8d..dc991d3bbbd3c281ecdfcd4ea699645ed2f79130 100644 (file)
--- a/src/lib/dhcp/option_definition.h
+++ b/src/lib/dhcp/option_definition.h
@@ -433,7 +433,9 @@ public:
     /// @param type option type.
     /// @param begin beginning of the option buffer.
     /// @param end end of the option buffer.
-    /// @param custom_data
+    /// @param custom_data flag letting know the factory that the buffer contains custom data.
+    ///                    Intended use case is @c OPT_CUSTOM_TYPE option def and csv-format=true.
+    ///                    Defaults to false.
     ///
     /// @return instance of the DHCP option.
     /// @throw InvalidOptionValue if data for the option is invalid.
@@ -673,7 +675,10 @@ private:
     /// @param u A universe (V4 or V6).
     /// @param begin beginning of the option buffer.
     /// @param end end of the option buffer.
-    /// @param custom_data
+    /// @param custom_data flag letting know the factory that the buffer contains custom data.
+    ///                    Intended use case is @c OPT_CUSTOM_TYPE option def and csv-format=true.
+    ///                    Defaults to false.
+    ///
     ///
     /// @return An instance of the option having special format or NULL if
     /// such an option can't be created because an option with the given