From: Guilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
Date: Thu, 5 Jan 2012 22:25:18 +0000 (-0200)
Subject: Documentation: small fixes.
X-Git-Tag: v1.3~11^2~51
X-Git-Url: http://developer.intra2net.com/git/?a=commitdiff_plain;h=c953662572fa326e4f87042f6250492ab69f8829;p=pingcheck

Documentation: small fixes.
---

diff --git a/src/host/messagepayload.cpp b/src/host/messagepayload.cpp
index e23dfa4..2e35adb 100644
--- a/src/host/messagepayload.cpp
+++ b/src/host/messagepayload.cpp
@@ -187,11 +187,11 @@ void MessagePayload::append(
 /**
  * @brief Retrieve 16 bits from the payload buffer.
  *
- * @param left_byte the index of the left byte
- * @param right_byte the index of the right byte
+ * @param left_byte The index of the left byte.
+ * @param right_byte The index of the right byte.
  *
- * @return a concatenation of the byte indexed by left_byte with the byte
- * indexed by right_byte.
+ * @return a concatenation of the byte indexed by @a left_byte with the byte
+ * indexed by @a right_byte.
  */
 uint16_t MessagePayload::decode16(
         const int left_byte,
@@ -214,10 +214,10 @@ uint16_t MessagePayload::decode16(
 /**
  * @brief Store 16 bits in the payload buffer.
  *
- * @param left_byte the index of the left byte
- * @param right_byte the index of the right byte
- * @param value a 16 bits data be saved in the bytes indexed by left_byte and
- * right_byte.
+ * @param left_byte The index of the left byte.
+ * @param right_byte The index of the right byte.
+ * @param value a 16 bits data be saved in the bytes indexed by @a left_byte and
+ * @a right_byte.
  *
  * @return void
  */
@@ -239,11 +239,11 @@ void MessagePayload::encode16(
 /**
  * @brief Retrieve 32 bits from the payload buffer.
  *
- * @param first_byte The index of the first byte out of 4
- * @param last_byte The index of the last byte out of 4
+ * @param first_byte The index of the first byte out of 4.
+ * @param last_byte The index of the last byte out of 4.
  *
- * @return a concatenation of 4 bytes, from the byte indexed by first_byte to
- * the byte indexed by last_byte.
+ * @return a concatenation of 4 bytes, from the byte indexed by @a first_byte to
+ * the byte indexed by @a last_byte.
  */
 uint32_t MessagePayload::decode32(
         const int first_byte,
@@ -271,10 +271,10 @@ uint32_t MessagePayload::decode32(
 /**
  * @brief Store 32 bits in the payload buffer.
  *
- * @param first_byte The index of the first byte out of 4
- * @param last_byte The index of the last byte out of 4
- * @param value a 32 bits data be saved in the bytes indexed from the first_byte
- * to the last_byte.
+ * @param first_byte The index of the first byte out of 4.
+ * @param last_byte The index of the last byte out of 4.
+ * @param value a 32 bits data be saved in the bytes indexed from the @a first_byte
+ * to the @a last_byte.
  *
  * @return void
  */