F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doxygen corrections for class Buffer

Browse Source
This commit is contained in:
Tom Henderson
2015-01-30 16:06:55 -08:00
parent 2ab35569ae
commit 2be7d2e686
1 changed files with 23 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
src/network/model/buffer.h
View File

@@ -139,7 +139,7 @@ public:
/**
* \param data data to write in buffer
*
* Write the data in buffer and avance the iterator position
* Write the data in buffer and advance the iterator position
* by one byte.
*/
inline void WriteU8 (uint8_t data);
@@ -147,14 +147,14 @@ public:
* \param data data to write in buffer
* \param len number of times data must be written in buffer
*
* Write the data in buffer len times and avance the iterator position
* Write the data in buffer len times and advance the iterator position
* by len byte.
*/
inline void WriteU8 (uint8_t data, uint32_t len);
/**
* \param data data to write in buffer
*
* Write the data in buffer and avance the iterator position
* Write the data in buffer and advance the iterator position
* by two bytes. The format of the data written in the byte
* buffer is non-portable. We only ensure that readU16 will
* return exactly what we wrote with writeU16 if the program
@@ -164,7 +164,7 @@ public:
/**
* \param data data to write in buffer
*
* Write the data in buffer and avance the iterator position
* Write the data in buffer and advance the iterator position
* by four bytes. The format of the data written in the byte
* buffer is non-portable. We only ensure that readU32 will
* return exactly what we wrote with writeU32 if the program
@@ -174,7 +174,7 @@ public:
/**
* \param data data to write in buffer
*
* Write the data in buffer and avance the iterator position
* Write the data in buffer and advance the iterator position
* by eight bytes. The format of the data written in the byte
* buffer is non-portable. We only ensure that readU64 will
* return exactly what we wrote with writeU64 if the program
@@ -184,15 +184,15 @@ public:
/**
* \param data data to write in buffer
*
* Write the data in buffer and avance the iterator position
* by two bytes. The data is written in network order and the
* Write the data in buffer and advance the iterator position
* by two bytes. The data is written in least significant byte order and the
* input data is expected to be in host order.
*/
void WriteHtolsbU16 (uint16_t data);
/**
* \param data data to write in buffer
*
* Write the data in buffer and avance the iterator position
* Write the data in buffer and advance the iterator position
* by four bytes. The data is written in least significant byte order and the
* input data is expected to be in host order.
*/
@@ -200,7 +200,7 @@ public:
/**
* \param data data to write in buffer
*
* Write the data in buffer and avance the iterator position
* Write the data in buffer and advance the iterator position
* by eight bytes. The data is written in least significant byte order and the
* input data is expected to be in host order.
*/
@@ -208,15 +208,15 @@ public:
/**
* \param data data to write in buffer
*
* Write the data in buffer and avance the iterator position
* by two bytes. The data is written in least significant byte order and the
* Write the data in buffer and advance the iterator position
* by two bytes. The data is written in network order and the
* input data is expected to be in host order.
*/
inline void WriteHtonU16 (uint16_t data);
/**
* \param data data to write in buffer
*
* Write the data in buffer and avance the iterator position
* Write the data in buffer and advance the iterator position
* by four bytes. The data is written in network order and the
* input data is expected to be in host order.
*/
@@ -224,7 +224,7 @@ public:
/**
* \param data data to write in buffer
*
* Write the data in buffer and avance the iterator position
* Write the data in buffer and advance the iterator position
* by eight bytes. The data is written in network order and the
* input data is expected to be in host order.
*/
@@ -233,7 +233,7 @@ public:
* \param buffer a byte buffer to copy in the internal buffer.
* \param size number of bytes to copy.
*
* Write the data in buffer and avance the iterator position
* Write the data in buffer and advance the iterator position
* by size bytes.
*/
void Write (uint8_t const*buffer, uint32_t size);
@@ -242,7 +242,7 @@ public:
* \param end the end of the data to copy
*
* Write the data delimited by start and end in internal buffer
* and avance the iterator position by the number of bytes
* and advance the iterator position by the number of bytes
* copied.
* The input interators _must_ not point to the same Buffer as
* we do to avoid overlapping copies. This is enforced
@@ -293,7 +293,7 @@ public:
*
* Read data and advance the Iterator by the number of bytes
* read.
* The data is read in network format and return in host format.
* The data is read in network format and returned in host format.
*/
inline uint16_t ReadNtohU16 (void);
/**
@@ -301,7 +301,7 @@ public:
*
* Read data and advance the Iterator by the number of bytes
* read.
* The data is read in network format and return in host format.
* The data is read in network format and returned in host format.
*/
inline uint32_t ReadNtohU32 (void);
/**
@@ -309,7 +309,7 @@ public:
*
* Read data and advance the Iterator by the number of bytes
* read.
* The data is read in network format and return in host format.
* The data is read in network format and returned in host format.
*/
uint64_t ReadNtohU64 (void);
/**
@@ -317,7 +317,7 @@ public:
*
* Read data and advance the Iterator by the number of bytes
* read.
* The data is read in network format and return in host format.
* The data is read in least significant byte format and returned in host format.
*/
uint16_t ReadLsbtohU16 (void);
/**
@@ -325,7 +325,7 @@ public:
*
* Read data and advance the Iterator by the number of bytes
* read.
* The data is read in network format and return in host format.
* The data is read in least significant byte format and returned in host format.
*/
uint32_t ReadLsbtohU32 (void);
/**
@@ -333,7 +333,7 @@ public:
*
* Read data and advance the Iterator by the number of bytes
* read.
* The data is read in network format and return in host format.
* The data is read in least signficant byte format and returned in host format.
*/
uint64_t ReadLsbtohU64 (void);
/**
@@ -417,7 +417,7 @@ private:
*
* Read data and advance the Iterator by the number of bytes
* read.
* The data is read in network format and return in host format.
* The data is read in network format and returned in host format.
*
* \warning this is the slow version, please use ReadNtohU16 (void)
*/
@@ -427,7 +427,7 @@ private:
*
* Read data and advance the Iterator by the number of bytes
* read.
* The data is read in network format and return in host format.
* The data is read in network format and returned in host format.
*
* \warning this is the slow version, please use ReadNtohU32 (void)
*/