Browse Source

[2414] get(), toText() descriptions updated.

Tomek Mrugalski 12 years ago
parent
commit
4d2adcc95c
1 changed files with 6 additions and 0 deletions
  1. 6 0
      src/lib/dhcp/subnet.h

+ 6 - 0
src/lib/dhcp/subnet.h

@@ -279,10 +279,16 @@ public:
     /// @return unique ID for that subnet
     SubnetID getID() const { return (id_); }
 
+    /// @brief returns subnet parameters (prefix and prefix length)
+    ///
+    /// @return (prefix, prefix length) pair
     std::pair<isc::asiolink::IOAddress, uint8_t> get() {
         return (std::pair<isc::asiolink::IOAddress, uint8_t>(prefix_, prefix_len_));
     }
 
+    /// @brief returns textual representation of the subnet (e.g. "2001:db8::/64")
+    ///
+    /// @return textual representation
     virtual std::string toText();
 
 protected: