Skip to content

Commit

Permalink
Fixing doxygen warnings
Browse files Browse the repository at this point in the history
Change-Id: Ib466ee62a4860d22c684791b700615e493e9355a
Original-Change-Id: I4d5445bf9c95631811366a16a9be1d8d440f14c1
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/45548
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Tested-by: PPE CI <ppe-ci+hostboot@us.ibm.com>
Tested-by: Hostboot CI <hostboot-ci+hostboot@us.ibm.com>
Reviewed-by: Matt K. Light <mklight@us.ibm.com>
Reviewed-by: Richard J. Knight <rjknight@us.ibm.com>
Reviewed-by: Jennifer A. Stofer <stofer@us.ibm.com>
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/47050
Tested-by: Jenkins OP Build CI <op-jenkins+hostboot@us.ibm.com>
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>
  • Loading branch information
kahnevan authored and dcrowell77 committed Oct 5, 2017
1 parent 67e37f1 commit 49acb2a
Showing 1 changed file with 14 additions and 15 deletions.
29 changes: 14 additions & 15 deletions src/import/hwpf/fapi2/include/collect_reg_ffdc.H
Expand Up @@ -50,7 +50,7 @@ void getAddressData(const fapi2::HwpFfdcId i_ffdcId,
///
/// @brief converts value to a type to enable overloading based on values
///
/// @tparam[in] v - value to create to a unique type
/// @tparam v - value to create to a unique type
///
/// @return v - value.
///
Expand Down Expand Up @@ -83,8 +83,6 @@ class TargetPosition
/// @brief Return position of either a chip or chiplet target
///
/// @param[out] o_pos - position of chip/chiplet target
/// @param[in] is_chiplet - converted to type for overloading
/// to correct function call.
///
/// @return fapi2::ReturnCode. FAPI_RC_SUCCESS, or failure value.
///
Expand Down Expand Up @@ -350,9 +348,10 @@ class ScomReader<TARGET_TYPE_DIMM>
///
/// collect all the data from a list of registers and return it to the caller
///
/// @tparam[in] T register data size - uint32_t or uint64_t
/// @tparam[in] U - reader object for specific data type
/// @tparam T register data size - uint32_t or uint64_t
/// @tparam U - reader object for specific data type
/// @param[in] i_addresses - vector containing either cfam or scom addresses
/// @param[in] i_reader - input reader object
/// @param[in] i_offset - optional offset to add to the address values
/// passed in the vector of addresses
/// @param[out] o_pData - pointer to the data destination
Expand Down Expand Up @@ -397,16 +396,17 @@ ReturnCode collectRegisterData(std::vector<T>& i_addresses, U& i_reader,


///
/// @brief read registers
/// @brief readRegisters
///
/// Template function to allow reading either scom and cfam data from registers
/// for a given target
///
/// @tparam[in] T - fapi2::TargetType
/// @tparam T - fapi2::TargetType
/// @param[in] i_target - fapi2::Target
/// @param[out] o_pData - pointer to a location to store register data
/// @param[in] i_cfamAddresses - vector of cfam addresses to read
/// @param[in] i_scomAddresses - vector of scom addresses to read
/// @param[i/o] input/output parm description
/// @param[in] i_childOffset - optional offset to address of child
///
/// @return fapi2::ReturnCode. FAPI_RC_SUCCESS, or failure value.
///
Expand Down Expand Up @@ -451,15 +451,14 @@ void readRegisters(const fapi2::Target<T>& i_target,
///
/// @brief Collect register data for child targets
///
/// @tparam[in] C - child target type
/// @tparam[in] T - parent target type
/// @tparam C - child target type
/// @tparam T - parent target type
/// @param[in] i_parent - fapi2::Target
/// @param[in] i_childState - fapi2::TargetState for child targets
/// @param[in] i_ffdcId - type of ffdc to be collected
/// @param[out] o_errorInfo - vector of shared pointers to fapi2::ErrorInfoFfdc type
/// @param[out] o_errorInfoFfdc - vector of shared pointers to fapi2::ErrorInfoFfdc type
/// for returned register data
/// @param[in] i_childOffsetMult - child offset for register calculations
/// @param[i/o] input/output parm description
///
///
template<fapi2::TargetType C, fapi2::TargetType T>
Expand Down Expand Up @@ -566,12 +565,12 @@ void collectRegFfdc(const fapi2::ffdc_t i_parent,
///
/// @brief Collect register data for a single target
///
/// @tparam[in] T - target type
/// @tparam T - target type
/// @param[in] i_target - fapi2::Target
/// @param[in] i_ffdcId - type of ffdc to be collected
/// @param[out] o_errorInfo - shared pointer to fapi2::ErrorInfoFfdc type
/// @param[out] o_errorInfoFfdc - shared pointer to fapi2::ErrorInfoFfdc type
/// for returned register data
/// @param[in] i_childOffsetMult - child offset for register calculations
/// @param[in] i_childOffset - child offset for register calculations
///
template<fapi2::TargetType T>
void collectRegFfdc(const fapi2::ffdc_t i_target,
Expand Down

0 comments on commit 49acb2a

Please sign in to comment.