Add doxygen fapi2 tooling, doc clean up

Change-Id: Ieb787904e7d359f966298cf834195bed5ce86207
Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/15730
Reviewed-by: Brian Silver <bsilver@us.ibm.com>
Tested-by: Brian Silver <bsilver@us.ibm.com>

4 files changed, 13 insertions, 13 deletions

diff --git a/src/import/hwpf/fapi2/include/buffer.H b/src/import/hwpf/fapi2/include/buffer.H
index e80359842..6d8916372 100644
--- a/src/import/hwpf/fapi2/include/buffer.H
+++ b/src/import/hwpf/fapi2/include/buffer.H
@@ -52,6 +52,7 @@ namespace fapi2
     class buffer : public buffer_base<T>
     {
     public:
+        /// Shortcut typedef to map to our traits class
         typedef typename buffer_base<T, buffer>::bits_type bits_type;
 
         ///
@@ -280,7 +281,7 @@ namespace fapi2
         /// @tparam L Length of bits to insert
         /// @tparam SS Start bit in source
         /// @tparam OT the type of the incoming (origin) data
-        /// @param[in] i_data OT value to copy into DataBuffer
+        /// @param[in] i_datain OT value to copy into DataBuffer
         ///    - data is taken left aligned
         /// @note Asserting that all the parameters are known at
         /// compile time so this can be templated only. If that is not
@@ -352,7 +353,7 @@ namespace fapi2
         /// @tparam SB Start bit to insert into
         /// @tparam L Length of bits to insert
         /// @tparam OT the type of the incoming (origin) data
-        /// @param[in] i_data OT value to copy into DataBuffer
+        /// @param[in] i_datain OT value to copy into DataBuffer
         ///    - data is taken right aligned
         /// @note Data is assumed to be aligned on the word boundary of L
         /// @note Asserting that all the parameters are known at
diff --git a/src/import/hwpf/fapi2/include/error_scope.H b/src/import/hwpf/fapi2/include/error_scope.H
index 53f9339d6..d510c6de9 100644
--- a/src/import/hwpf/fapi2/include/error_scope.H
+++ b/src/import/hwpf/fapi2/include/error_scope.H
@@ -70,7 +70,7 @@
 /// @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
-/// @param[in] Optional vararg format/agruments for trace output.
+/// @param[in] ... vararg format/agruments for trace output (optional)
 /// @note This implementation does not support PIB error masks or
 /// FSP operational states.
 /// @warning The trace information is only going to be seen during
diff --git a/src/import/hwpf/fapi2/include/return_code.H b/src/import/hwpf/fapi2/include/return_code.H
index 5c8912474..0442ca89d 100644
--- a/src/import/hwpf/fapi2/include/return_code.H
+++ b/src/import/hwpf/fapi2/include/return_code.H
@@ -119,7 +119,7 @@ namespace fapi2
 
         ///
         /// @brief Constructor.
-        /// @param[in] The rc to set
+        /// @param[in] i_rc the rc to set
         ///
         ReturnCode(const uint64_t i_rc = FAPI2_RC_SUCCESS):
             iv_rc(i_rc)
@@ -168,13 +168,12 @@ namespace fapi2
         uint64_t iv_rc;
     };
 
-
     /// This implementation assumes no exception handling and leverages thread-local
     /// storage. For platforms without thread support, a global variable will
     /// suffice for the error state.
-    extern thread_local ReturnCode current_err;
-    extern thread_local uint64_t pib_error_mask;
-    extern thread_local uint64_t operational_state;
+    extern thread_local ReturnCode current_err;      /// the current error state
+    extern thread_local uint64_t pib_error_mask;     /// the pib mask
+    extern thread_local uint64_t operational_state;  /// the operational mode
 
 };
 
diff --git a/src/import/hwpf/fapi2/include/variable_buffer.H b/src/import/hwpf/fapi2/include/variable_buffer.H
index bf950f89c..a12808308 100644
--- a/src/import/hwpf/fapi2/include/variable_buffer.H
+++ b/src/import/hwpf/fapi2/include/variable_buffer.H
@@ -34,6 +34,7 @@
 
 namespace fapi2
 {
+    /// @brief Get a 32 bit mask quickly
     // This is one of the main reasons we static_assert in the ctor's
     // to ensure the unit_type is 32 bits.
     inline uint32_t fast_mask32(int32_t i_pos, int32_t i_len)
@@ -71,7 +72,6 @@ namespace fapi2
     ///            incoming data
     /// @param[in] i_target_start_bit The starting bit position in this
     /// @param[in] i_length The length, in bits, the user wants copied.
-    /// @endcond
     ///
     template<typename unit_type, typename bits_type>
     inline fapi2::ReturnCode _insert(const unit_type* i_source,
@@ -154,6 +154,7 @@ namespace fapi2
 
         return fapi2::FAPI2_RC_SUCCESS;
     }
+    /// @endcond
 
     /// @brief Class representing a FAPI variable_buffer.
     /// @remark Variable buffers are buffers which can be variable in length
@@ -422,11 +423,11 @@ namespace fapi2
 
         ///
         /// @brief Copy in a right aligned (decimal) element
-        /// @param[in] i_data, the incoming data
+        /// @param[in] i_data the incoming data
         ///    - data is taken right aligned
         /// @param[in] i_targetStart The starting bit position in this
         ///            - Defaultst to 0
-        /// @param[in] i_length The length, in bits, the user wants copied.
+        /// @param[in] i_len The length, in bits, the user wants copied.
         ///            - Defaults to all of the bits in the source which fit
         /// @return FAPI2_RC_SUCCESS on success, FAPI2_RC_OVERFLOW otherwise
         ///
@@ -518,7 +519,7 @@ namespace fapi2
 
 
 
-
+    /// @cond
     //
     // Generic insert
     //
@@ -656,7 +657,6 @@ namespace fapi2
         bits_type i_offset);
 #endif
     /// @endcond
-
 };