Merge pull request #154 from SwRaw/swraw/docs

updating metadata in the docs

docs/api.rst

------
-API
------
-
-.. doxygenindex::

docs/doxygen/Doxyfile

@@ -51,7 +51,7 @@ PROJECT_BRIEF          = "prototype interfaces compatible with ROCm platform and
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO           = 
+PROJECT_LOGO           =
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -775,7 +775,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ../../src/ \
+INPUT                  = ../../src/header \
                          ../../src/include
 
 # This tag can be used to specify the character encoding of the source files

docs/how to/use-transferbench.rst

 .. meta::
   :description: TransferBench is a utility to benchmark simultaneous transfers between user-specified devices (CPUs or GPUs)
-  :keywords: Using TransferBench, TransferBench Usage, TransferBench How To, API, ROCm, documentation, HIP
+  :keywords: TransferBench usage, TransferBench how to, TransferBench user guide, TransferBench user manual
 
 .. _using-transferbench:
 

docs/index.rst

 .. meta::
   :description: TransferBench is a utility to benchmark simultaneous transfers between user-specified devices (CPUs or GPUs)
-  :keywords: TransferBench, API, ROCm, documentation, HIP
+  :keywords: Benchmarking utility, Memory transfers, Device transfers
 
 ****************************
 TransferBench documentation

docs/install/install.rst

 .. meta::
   :description: TransferBench is a utility to benchmark simultaneous transfers between user-specified devices (CPUs or GPUs)
-  :keywords: Build TransferBench, Install TransferBench, API, ROCm, HIP
+  :keywords: Build TransferBench, Install TransferBench
 
 .. _install-transferbench:
 

docs/reference/api.rst

 .. meta::
   :description: TransferBench is a utility to benchmark simultaneous transfers between user-specified devices (CPUs or GPUs)
-  :keywords: TransferBench API, TransferBench library, documentation, HIP
+  :keywords: TransferBench library, TransferBench functions, Transferbench API, Transferbench interface
 
 .. _transferbench-api:
 

src/header/TransferBench.hpp

@@ -20,6 +20,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 */
 
+/// @cond
 #pragma once
 #include <cstring>
 #include <future>
@@ -41,6 +42,7 @@ THE SOFTWARE.
 #include <hsa/hsa.h>
 #include <hsa/hsa_ext_amd.h>
 #endif
+/// @endcond
 
 namespace TransferBench
 {
@@ -118,7 +120,7 @@ namespace TransferBench
    */
   struct Transfer
   {
-    size_t            numBytes    = (1<<26);    ///< # of bytes to Transfer
+    size_t            numBytes    = (1<<26);    ///< Number of bytes to Transfer
     vector<MemDevice> srcs        = {};         ///< List of source memory devices
     vector<MemDevice> dsts        = {};         ///< List of destination memory devices
     ExeDevice         exeDevice   = {};         ///< Executor to use
@@ -132,8 +134,8 @@ namespace TransferBench
    */
   struct GeneralOptions
   {
-    int numIterations      = 10;                ///< # of timed iterations to perform. If negative, run for -numIterations seconds instead
-    int numSubIterations   = 1;                 ///< # of sub-iterations per iteration
+    int numIterations      = 10;                ///< Number of timed iterations to perform. If negative, run for -numIterations seconds instead
+    int numSubIterations   = 1;                 ///< Number of sub-iterations per iteration
     int numWarmups         = 3;                 ///< Number of un-timed warmup iterations to perform
     int recordPerIteration = 0;                 ///< Record per-iteration timing information
     int useInteractive     = 0;                 ///< Pause for user-input before starting transfer loop
@@ -459,6 +461,8 @@ namespace TransferBench
 
 namespace TransferBench
 {
+
+/// @cond
 // Helper functions ('hidden' in anonymous namespace)
 //========================================================================================
 namespace {
@@ -468,8 +472,8 @@ namespace {
   int   constexpr MAX_BLOCKSIZE  = 512;                       // Max threadblock size
   int   constexpr MAX_WAVEGROUPS = MAX_BLOCKSIZE / 64;        // Max wavegroups/warps
   int   constexpr MAX_UNROLL     = 8;                         // Max unroll factor
-  int   constexpr MAX_SRCS       = 8;                         // Max # srcs per Transfer
-  int   constexpr MAX_DSTS       = 8;                         // Max # dsts per Transfer
+  int   constexpr MAX_SRCS       = 8;                         // Max number of srcs per Transfer
+  int   constexpr MAX_DSTS       = 8;                         // Max number of dsts per Transfer
   int   constexpr MEMSET_CHAR    = 75;                        // Value to memset (char)
   float constexpr MEMSET_VAL     = 13323083.0f;               // Value to memset (double)
 
@@ -2108,6 +2112,7 @@ namespace {
 
 } // End of anonymous namespace
 //========================================================================================
+/// @endcond
 
   ErrResult::ErrResult(ErrType err) : errType(err), errMsg("") {};