Commit eb591a94 authored by Tomek Mrugalski's avatar Tomek Mrugalski 🛰
Browse files

[1239] Comments improved.

parent 09f2de75
......@@ -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
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment