Making ROCTx API doxygen generated document more readable (#385)
* Making ROCTx API doxygen generated document more readable
* fixing build
* Fix linking errors
* Fixing header
* Fixing Topics and Types
* doxygen configuration fixes
* Fixing build
* Fix unnecessory doc parsing warnings
* formatting and linting fixes
* rebasing SDK modular PR
* Fixing missing line
* Fixing ROCtx documentation after merge
* Removing flake changes
* changed back WARN_IF_DOC_ERROR to Yes
[ROCm/rocprofiler-sdk commit: b48fa532bc]
此提交包含在:
1 父節點
4d29b74750
當前提交
abf3f869e9
32 file changed
+240
-24
No files matched your search
@@ -32,7 +32,7 @@
|
||||
* dynamically loading the shared library with @p dlopen, the address of each
|
||||
* function can be obtained using @p dlsym with the name of the function and
|
||||
* its corresponding symbol version string. An error will be reported by @p
|
||||
* dlvsym if the installed library does not support the version for the
|
||||
* dlsym if the installed library does not support the version for the
|
||||
* function specified in this version of the interface.
|
||||
*
|
||||
* @{
|
||||
|
||||
@@ -79,7 +79,7 @@ ROCTX_EXTERN_C_INIT
|
||||
|
||||
/** @defgroup marker_group ROCTx Markers
|
||||
*
|
||||
* Marker annotations are used to describe events in a ROCm application.
|
||||
* @brief Markers are used to annotate specific events in the code execution.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
@@ -96,8 +96,14 @@ roctxMarkA(const char* message) ROCTX_API ROCTX_NONNULL(1);
|
||||
|
||||
/** @defgroup range_group ROCTx Ranges
|
||||
*
|
||||
* Range annotations are used to describe events in a ROCm application.
|
||||
* @brief Ranges are used to describe a span of code execution in a ROCm application.
|
||||
*
|
||||
* Ranges can be nested, and the API provides functions to start and stop ranges.
|
||||
* Ranges are thread-local, meaning that each thread can have its own stack of
|
||||
* ranges. The API provides functions to push and pop ranges from the stack.
|
||||
* The API also provides functions to start and stop ranges, which are
|
||||
* process-wide. Each range is assigned a unique ID, which can be used to
|
||||
* identify the range when stopping it.
|
||||
* @{
|
||||
*/
|
||||
|
||||
@@ -152,7 +158,7 @@ roctxRangeStop(roctx_range_id_t id) ROCTX_API;
|
||||
|
||||
/** @defgroup PROFILER_COMM ROCTx Application control/customization of profiling tools
|
||||
*
|
||||
* Applications can invoke these functions to control/customize profiling tool behavior.
|
||||
* @brief Applications can invoke these functions to control/customize profiling tool behavior.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
@@ -192,6 +198,15 @@ roctxProfilerPause(roctx_thread_id_t tid) ROCTX_API;
|
||||
int
|
||||
roctxProfilerResume(roctx_thread_id_t tid) ROCTX_API;
|
||||
|
||||
/** @} */
|
||||
|
||||
/** \defgroup UTILITIES ROCTx Utility functions
|
||||
*
|
||||
* @brief Utility functions for profiling tools to customize their behavior.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Indicate to a profiling tool that, where possible, you would like the current CPU OS
|
||||
* thread to be labeled by the provided name in the output of the profiling tool.
|
||||
|
||||
@@ -26,9 +26,9 @@
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
/** @defgroup DATA_TYPE ROCTx Data types
|
||||
/** \defgroup BASIC_DATA_TYPES ROCTx Data types
|
||||
*
|
||||
* Data types defined or aliased by ROCTx
|
||||
* @brief Data types defined or aliased by ROCTx
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
Reference in new issue
封鎖使用者