rocprofv3: docs and help menu updates (#1129)

* doc updates

* Correcting ROCtx information

* Making ROCTx string consistent

* missing occurence

[ROCm/rocprofiler-sdk commit: 320427b5f5]
This commit is contained in:
Gopesh Bhardwaj
2024-10-17 13:28:53 +05:30
committed by GitHub
orang tua ad4b331279
melakukan 63c5f87b85
9 mengubah file dengan 33 tambahan dan 25 penghapusan
@@ -22,16 +22,16 @@
#pragma once
/** \mainpage ROCTX API Specification
/** \mainpage ROCTx API Specification
*
* \section introduction Introduction
* ROCTX is a library that implements the AMD code annotation API. It provides
* ROCTx is a library that implements the AMD code annotation API. It provides
* the support necessary to annotate events and code ranges in applications.
*/
/**
* \file
* ROCTX API interface.
* ROCTx API interface.
*/
#include <stddef.h>
@@ -43,7 +43,7 @@
ROCTX_EXTERN_C_INIT
/** \defgroup marker_group ROCTX Markers
/** \defgroup marker_group ROCTx Markers
*
* Marker annotations are used to describe events in a ROCm application.
*
@@ -60,7 +60,7 @@ roctxMarkA(const char* message) ROCTX_API ROCTX_NONNULL(1);
/** @} */
/** \defgroup range_group ROCTX Ranges
/** \defgroup range_group ROCTx Ranges
*
* Range annotations are used to describe events in a ROCm application.
*
@@ -114,7 +114,7 @@ roctxRangeStop(roctx_range_id_t id) ROCTX_API;
/** @} */
/** \defgroup PROFILER_COMM ROCTX Application control/customization of profiling tools
/** \defgroup PROFILER_COMM ROCTx Application control/customization of profiling tools
*
* Applications can invoke these functions to control/customize profiling tool behavior.
*
@@ -26,7 +26,7 @@
#include <stdint.h>
/** \defgroup DATA_TYPE ROCTX Data types
/** \defgroup DATA_TYPE ROCTx Data types
*
* Data types defined or aliased by ROCTx
*
@@ -34,20 +34,20 @@
*/
/**
* ROCTX range ID.
* ROCTx range ID.
*
* This is the range ID used to identify start/end ranges.
*/
/**
* @brief ROCTX range ID.
* @brief ROCTx range ID.
*
* This is the range ID used to identify start/end ranges.
*/
typedef uint64_t roctx_range_id_t;
/**
* @brief ROCTX thread ID.
* @brief ROCTx thread ID.
*
* This is the thread ID used to identify OS threads
*/