From: Tomek Mrugalski <tomasz@isc.org>
Date: Tue, 30 Oct 2012 17:19:50 +0000 (+0100)
Subject: [2414] get(), toText() descriptions updated.
X-Git-Tag: trac2487_base~1^2~31^2~32
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=4d2adcc95c4a49ff7efa67a1f9e188a9e3e96dca;p=thirdparty%2Fkea.git

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

diff --git a/src/lib/dhcp/subnet.h b/src/lib/dhcp/subnet.h
index b009b3cde0..889e24b37c 100644
--- a/src/lib/dhcp/subnet.h
+++ b/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: