]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[1239] Comments improved.
authorTomek Mrugalski <tomasz@isc.org>
Wed, 14 Dec 2011 17:46:26 +0000 (18:46 +0100)
committerTomek Mrugalski <tomasz@isc.org>
Wed, 14 Dec 2011 17:46:26 +0000 (18:46 +0100)
src/lib/dhcp/option.h

index daf5afc61da8c7f51d93034ced2796f481707f8c..ff4f36e8c1344d103a916329221ee8e94dcbe11f 100644 (file)
@@ -239,23 +239,23 @@ public:
 
     /// @brief Returns content of first byte.
     ///
-    /// This method will throw OutOfRange if option has 0 length.
+    /// @exception OutOfRange Thrown if the option has a length of 0.
     ///
     /// @return value of the first byte
     uint8_t getUint8();
 
     /// @brief Returns content of first word.
     ///
-    /// This method will throw OutOfRange if option has less than 2 length.
+    /// @exception OutOfRange Thrown if the option has a length less than 2.
     ///
     /// @return uint16_t value stored on first two bytes
     uint16_t getUint16();
 
     /// @brief Returns content of first double word.
     ///
-    /// This method will throw OutOfRange if option has less than 4 length.
+    /// @exception OutOfRange Thrown if the option has a length less than 4.
     ///
-    /// @return uint14_t value stored on first four bytes
+    /// @return uint32_t value stored on first four bytes
     uint32_t getUint32();
 
     /// just to force that every option has virtual dtor