diff options
| author | Brian Silver <bsilver@us.ibm.com> | 2015-02-13 13:39:53 -0600 |
|---|---|---|
| committer | Joshua Hunsberger <jahunsbe@us.ibm.com> | 2017-10-23 15:50:51 -0500 |
| commit | a6df645c520891ca8adfed7c0e7ef056a49a5133 (patch) | |
| tree | e4985acbe5297d343ef869db0634b9695c28125e /import/hwpf/fapi2/include | |
| parent | 360ef22ccf2715d9581e78a088449e0b164d6486 (diff) | |
| download | talos-hcode-a6df645c520891ca8adfed7c0e7ef056a49a5133.tar.gz talos-hcode-a6df645c520891ca8adfed7c0e7ef056a49a5133.zip | |
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>
Diffstat (limited to 'import/hwpf/fapi2/include')
| -rw-r--r-- | import/hwpf/fapi2/include/buffer.H | 5 | ||||
| -rw-r--r-- | import/hwpf/fapi2/include/error_scope.H | 2 |
2 files changed, 4 insertions, 3 deletions
diff --git a/import/hwpf/fapi2/include/buffer.H b/import/hwpf/fapi2/include/buffer.H index 363d69ac..3082e41f 100644 --- a/import/hwpf/fapi2/include/buffer.H +++ b/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/import/hwpf/fapi2/include/error_scope.H b/import/hwpf/fapi2/include/error_scope.H index 6b265343..fadcb1e1 100644 --- a/import/hwpf/fapi2/include/error_scope.H +++ b/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 |
