]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[2414] get(), toText() descriptions updated.
authorTomek Mrugalski <tomasz@isc.org>
Tue, 30 Oct 2012 17:19:50 +0000 (18:19 +0100)
committerTomek Mrugalski <tomasz@isc.org>
Tue, 30 Oct 2012 17:19:50 +0000 (18:19 +0100)
src/lib/dhcp/subnet.h

index b009b3cde0136c4d3a2c2285b95212733ea79dcf..889e24b37c6bc86bba521062b047dabac361c010 100644 (file)
@@ -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: