fapi2 doxygen warning/error cleanup from ecmd repository

Change-Id: I502a6f79f461632588b46e51d5892e2d6b74942d
Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/20985
Tested-by: Jenkins Server
Reviewed-by: Matt K. Light <mklight@us.ibm.com>
Reviewed-by: Brian Silver <bsilver@us.ibm.com>
Reviewed-by: Jennifer A. Stofer <stofer@us.ibm.com>

3 files changed, 24 insertions, 24 deletions

diff --git a/import/hwpf/fapi2/include/buffer.H b/import/hwpf/fapi2/include/buffer.H
index deabcda4..e5dd4331 100644
--- a/import/hwpf/fapi2/include/buffer.H
+++ b/import/hwpf/fapi2/include/buffer.H
@@ -506,11 +506,11 @@ class buffer
         ///
         /// @brief Copy part of a OT into the DataBuffer
         /// @tparam OT the type of the incoming (origin) data
-        /// @param[in] i_datain OT value to copy into DataBuffer
-        ///    - data is taken left aligned
-        /// @param[in] Start bit to insert into (target start)
-        /// @param[in] Length of bits to insert
-        /// @param[in] Start bit in source - defaults to bit 0
+        /// @param[in] i_datain      OT value to copy into DataBuffer
+        ///                          - data is taken left aligned
+        /// @param[in] i_targetStart bit to insert into (target start)
+        /// @param[in] i_len         Length of bits to insert
+        /// @param[in] i_sourceStart Start bit in source - defaults to bit 0
 
         /// @return FAPI2_RC_SUCCESS if successful
         ///
@@ -605,10 +605,10 @@ class buffer
         ///
         /// @brief Copy in a right aligned value
         /// @tparam OT the type of the incoming (origin) data
-        /// @param[in] i_datain OT value to copy into DataBuffer
-        ///    - data is taken right aligned
-        /// @param[in] Start bit to insert into
-        /// @param[in] Length of bits to insert
+        /// @param[in] i_datain      OT value to copy into DataBuffer
+        ///                          - data is taken right aligned
+        /// @param[in] i_targetStart Start bit to insert into
+        /// @param[in] i_len         Length of bits to insert
         /// @return FAPi2_RC_SUCCESS if no error
         /// @note Data is assumed to be aligned on the word boundary of L
         ///
@@ -683,10 +683,10 @@ class buffer
         ///
         /// @brief Copy data from this buffer into an OT
         /// @tparam OT the type of the outgoing (target)
-        /// @param[out] o_out OT to copy into - data is placed left aligned
-        /// @param[in] Start bit in source
-        /// @param[in] Length of bits to extract
-        /// @param[in] Start bit to insert into (target start)
+        /// @param[out] o_out        OT to copy into - data is placed left aligned
+        /// @param[in] i_sourceStart Start bit in source
+        /// @param[in] i_len         Length of bits to extract
+        /// @param[in] i_targetStart Start bit to insert into (target start)
         /// @return FAPI2_RC_SUCCESS if ok
         ///
         template<typename OT>
@@ -740,9 +740,9 @@ class buffer
         ///
         /// @brief Copy data from this buffer into an OT and right justify
         /// @tparam OT the type of the outgoing (target)
-        /// @param[out] o_out OT to copy into - data is placed right aligned
-        /// @param[in] Start bit to insert into (source start)
-        /// @param[in] Length of bits to insert
+        /// @param[out] o_out        OT to copy into - data is placed right aligned
+        /// @param[in] i_sourceStart Start bit to insert into (source start)
+        /// @param[in] i_len         Length of bits to insert
         /// @return FAPI2_RC_SUCCESS if ok
         ///
         template<typename OT>
diff --git a/import/hwpf/fapi2/include/buffer_traits.H b/import/hwpf/fapi2/include/buffer_traits.H
index f9e3bab5..5fb8664b 100644
--- a/import/hwpf/fapi2/include/buffer_traits.H
+++ b/import/hwpf/fapi2/include/buffer_traits.H
@@ -82,7 +82,7 @@ class bufferTraits
         ///
         /// @brief Return the size of the buffer in E units
         /// @tparam E, the element size.
-        /// @param[in] io_buffer the buffer which to size
+        /// @param[in] i_buffer the buffer which to size
         /// @return The size of the buffer in E's rounded up
         ///
         template<typename E>
@@ -95,7 +95,7 @@ class bufferTraits
 
         ///
         /// @brief Return the size of the buffer itself
-        /// @param[in] io_buffer the buffer which to size
+        /// @param[in] i_buffer the buffer which to size
         /// @return The size of the buffer in bits (not units)
         ///
         constexpr static B bit_length(const T&)
@@ -197,7 +197,7 @@ class bufferTraits<bits_container, uint32_t>
         ///
         /// @brief Return the size of the buffer in E units
         /// @tparam E, the element size.
-        /// @param[in] io_buffer the buffer which to size
+        /// @param[in] i_buffer the buffer which to size
         /// @return The size of the buffer in E's rounded up
         ///
         template<typename E>
@@ -210,7 +210,7 @@ class bufferTraits<bits_container, uint32_t>
 
         ///
         /// @brief Return the size of the buffer itself
-        /// @param[in,out] io_buffer the buffer which to size
+        /// @param[in] i_buffer the buffer which to size
         /// @return The size of the buffer in bits (not units)
         ///
         static inline uint32_t bit_length(const bits_container& i_buffer)
diff --git a/import/hwpf/fapi2/include/fapi2_error_scope.H b/import/hwpf/fapi2/include/fapi2_error_scope.H
index 278e1417..56655a5c 100644
--- a/import/hwpf/fapi2/include/fapi2_error_scope.H
+++ b/import/hwpf/fapi2/include/fapi2_error_scope.H
@@ -53,8 +53,8 @@
 
 ///
 /// @brief Wrapper to check an operation for an error state
-/// and jump to the label cleam_up if there is an error.
-/// @param[in] __operation__ an operation which returns a fapi::ReturnCode
+/// and jump to the label clean_up if there is an error.
+/// @param[in] \__operation__ an operation which returns a fapi::ReturnCode
 /// @param[in] ... vararg format/agruments for trace output (optional)
 /// @note This implementation does not support PIB error masks or
 /// FSP operational states.
@@ -69,8 +69,8 @@
 /// @brief Assert a conditional is true.
 /// If it is not, the FFDC gathering function is called and the
 /// trace is output as a FAPI error trace.
-/// @param[in] __conditional__ the condition to assert
-/// @param[in] __ffdc__ the FFDC gathering function
+/// @param[in] \__conditional__ the condition to assert
+/// @param[in] \__ffdc__ the FFDC gathering function
 /// @param[in] ... varargs, as input to FAPI_ERR
 ///
 #define FAPI_ASSERT( __conditional__, __ffdc__, ... ) PLAT_FAPI_ASSERT( __conditional__, __ffdc__, __VA_ARGS__ )