Small documentation change in IP header classes: specifying the unit.
authorGuilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
Sat, 19 Nov 2011 16:59:57 +0000 (14:59 -0200)
committerGuilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
Sat, 19 Nov 2011 16:59:57 +0000 (14:59 -0200)
src/ip/ipv4header.cpp
src/ip/ipv6header.cpp
src/ip/ipv6header.h

index 6403d8d..e8e2cbf 100644 (file)
@@ -72,7 +72,7 @@ uint8_t Ipv4Header::get_differentiated_services() const
 }
 
 /**
- * @brief Get the packet total length.
+ * @brief Get the packet Total Length in bytes.
  *
  * The Total Length includes everything in the datagram - both header and data.
  * The maximum length is 65,535 bytes.
index 6b521fa..be6227b 100644 (file)
@@ -74,7 +74,7 @@ uint32_t Ipv6Header::get_flow_label() const
 }
 
 /**
- * @brief Get the Payload Length field.
+ * @brief Get the Payload Length in bytes.
  *
  * This field tells how many bytes follow the 40-byte fixed length IPv6 header.
  *
index 5628a47..cd287e3 100644 (file)
@@ -30,7 +30,7 @@
  * |  (6)  |               |                                      |       |
  * +-------+---------------+-------+--------------+---------------+       |
  * |                               |              |               |       |
- * |        payload length         | next header  |   hop limit   |       |
+ * |    payload length in bytes    | next header  |   hop limit   |       |
  * |                               |              |               |       |
  * +---------------+---------------+--------------+---------------+       |
  * |                                                              |       |