diff --git a/source/docs/_toc.yml.in b/source/docs/_toc.yml.in index 40a6d60929..5653ea9b1f 100644 --- a/source/docs/_toc.yml.in +++ b/source/docs/_toc.yml.in @@ -60,8 +60,22 @@ subtrees: - file: _doxygen/rocprofiler-sdk/html/topics - file: _doxygen/rocprofiler-sdk/html/annotated - file: _doxygen/rocprofiler-sdk/html/files - - file: _doxygen/roctx/html/index - title: ROCTx API library + - file: api-reference/rocprofiler-sdk-roctx_api_reference + subtrees: + - entries: + - file: api-reference/rocprofiler-sdk-roctx_api/roctx_modules + subtrees: + - entries: + - file: api-reference/rocprofiler-sdk-roctx_api/roctx_modules/markers + - file: api-reference/rocprofiler-sdk-roctx_api/roctx_modules/ranges + - file: api-reference/rocprofiler-sdk-roctx_api/roctx_modules/profiler-control + - file: api-reference/rocprofiler-sdk-roctx_api/roctx_modules/naming-utilities + - file: api-reference/rocprofiler-sdk-roctx_api/global_roctx_data_structures_topics_files + subtrees: + - entries: + - file: api-reference/rocprofiler-sdk-roctx_api/global_roctx_data_structures_topics_files/global_roctx_basic_data_types + - file: _doxygen/roctx/html/topics + - file: _doxygen/roctx/html/files - caption: Conceptual entries: - file: conceptual/comparing-with-legacy-tools diff --git a/source/docs/api-reference/rocprofiler-sdk-roctx_api/global_roctx_data_structures_topics_files.rst b/source/docs/api-reference/rocprofiler-sdk-roctx_api/global_roctx_data_structures_topics_files.rst new file mode 100644 index 0000000000..4ffe0e266d --- /dev/null +++ b/source/docs/api-reference/rocprofiler-sdk-roctx_api/global_roctx_data_structures_topics_files.rst @@ -0,0 +1,15 @@ +.. meta:: + :description: The Global Data structures, topics and files reference page. + +.. _global_roctx_data_structures_topics_files_reference: + +******************************************************************************* +Global Data structures, topics, files +******************************************************************************* + +This ROCprofiler-SDK-ROCTx API topic covers: + +* :ref:`global_roctx_basic_data_types_reference` +* :doc:`../../_doxygen/roctx/html/topics` +* :doc:`../../_doxygen/roctx/html/files` + diff --git a/source/docs/api-reference/rocprofiler-sdk-roctx_api/global_roctx_data_structures_topics_files/global_roctx_basic_data_types.rst b/source/docs/api-reference/rocprofiler-sdk-roctx_api/global_roctx_data_structures_topics_files/global_roctx_basic_data_types.rst new file mode 100644 index 0000000000..304100e7ad --- /dev/null +++ b/source/docs/api-reference/rocprofiler-sdk-roctx_api/global_roctx_data_structures_topics_files/global_roctx_basic_data_types.rst @@ -0,0 +1,12 @@ +.. meta:: + :description: The global basic data types reference page. + +.. _global_roctx_basic_data_types_reference: + +******************************************************************************* +Global Basic Data Types +******************************************************************************* + +.. doxygengroup:: BASIC_DATA_TYPES + :content-only: + :project: roctx diff --git a/source/docs/api-reference/rocprofiler-sdk-roctx_api/roctx_modules.rst b/source/docs/api-reference/rocprofiler-sdk-roctx_api/roctx_modules.rst new file mode 100644 index 0000000000..2936dfff62 --- /dev/null +++ b/source/docs/api-reference/rocprofiler-sdk-roctx_api/roctx_modules.rst @@ -0,0 +1,17 @@ +.. meta:: + :description: The ROCprofiler-SDK-ROCTx API modules reference page. + :keywords: AMD, ROCm, modules + +.. _roctx_modules_reference: + +******************************************************************************* +Modules +******************************************************************************* + +The ROCprofiler-SDK-ROCTx API is organized into the following modules based on functionality: + +* :ref:`markers_information_reference` +* :ref:`ranges_information_reference` +* :ref:`profiler-control_information_reference` +* :ref:`naming-utilities_information_reference` + diff --git a/source/docs/api-reference/rocprofiler-sdk-roctx_api/roctx_modules/markers.rst b/source/docs/api-reference/rocprofiler-sdk-roctx_api/roctx_modules/markers.rst new file mode 100644 index 0000000000..8624cf311b --- /dev/null +++ b/source/docs/api-reference/rocprofiler-sdk-roctx_api/roctx_modules/markers.rst @@ -0,0 +1,12 @@ +.. meta:: + :description: Markers Information reference page. + +.. _markers_information_reference: + +******************************************************************************* +Markers Information +******************************************************************************* + +.. doxygengroup:: marker_group + :content-only: + :project: roctx diff --git a/source/docs/api-reference/rocprofiler-sdk-roctx_api/roctx_modules/naming-utilities.rst b/source/docs/api-reference/rocprofiler-sdk-roctx_api/roctx_modules/naming-utilities.rst new file mode 100644 index 0000000000..7459a0e60b --- /dev/null +++ b/source/docs/api-reference/rocprofiler-sdk-roctx_api/roctx_modules/naming-utilities.rst @@ -0,0 +1,12 @@ +.. meta:: + :description: Naming utilities Information reference page. + +.. _naming-utilities_information_reference: + +******************************************************************************* +Naming Information +******************************************************************************* + +.. doxygengroup:: UTILITIES + :content-only: + :project: roctx diff --git a/source/docs/api-reference/rocprofiler-sdk-roctx_api/roctx_modules/profiler-control.rst b/source/docs/api-reference/rocprofiler-sdk-roctx_api/roctx_modules/profiler-control.rst new file mode 100644 index 0000000000..66a249c690 --- /dev/null +++ b/source/docs/api-reference/rocprofiler-sdk-roctx_api/roctx_modules/profiler-control.rst @@ -0,0 +1,12 @@ +.. meta:: + :description: Profiler Control Information reference page. + +.. _profiler-control_information_reference: + +******************************************************************************* +Profiler Control Information +******************************************************************************* + +.. doxygengroup:: PROFILER_COMM + :content-only: + :project: roctx diff --git a/source/docs/api-reference/rocprofiler-sdk-roctx_api/roctx_modules/ranges.rst b/source/docs/api-reference/rocprofiler-sdk-roctx_api/roctx_modules/ranges.rst new file mode 100644 index 0000000000..629c0675b5 --- /dev/null +++ b/source/docs/api-reference/rocprofiler-sdk-roctx_api/roctx_modules/ranges.rst @@ -0,0 +1,12 @@ +.. meta:: + :description: Ranges Information reference page. + +.. _ranges_information_reference: + +******************************************************************************* +Ranges Information +******************************************************************************* + +.. doxygengroup:: range_group + :content-only: + :project: roctx diff --git a/source/docs/api-reference/rocprofiler-sdk-roctx_api_reference.rst b/source/docs/api-reference/rocprofiler-sdk-roctx_api_reference.rst new file mode 100644 index 0000000000..58135bc2bc --- /dev/null +++ b/source/docs/api-reference/rocprofiler-sdk-roctx_api_reference.rst @@ -0,0 +1,66 @@ +.. meta:: + :description: ROCprofiler-SDK-ROCTx API reference page + :keywords: AMD, ROCm, HSA + +.. _rocprofiler_sdk_roctx_api_reference: + +******************************************************************************** +ROCTx API +******************************************************************************** + +Introduction +============ + +ROCTx is a comprehensive library that implements the AMD code annotation API. It provides +essential functionality for: + +- Event annotation and marking +- Code range tracking and management +- Profiler control and customization +- Thread and device naming capabilities + +Key features: + +- Nested range tracking with push/pop functionality +- Process-wide range management +- Thread-specific and global profiler control +- Device and stream naming support +- HSA agent and HIP device management + +The API is divided into several main components: + +1. **Markers** - For single event annotations +2. **Ranges** - For tracking code execution spans +3. **Profiler Control** - For managing profiling tool behavior +4. **Naming Utilities** - For labeling threads, devices, and streams + +Thread Safety: + +- Range operations are thread-local and thread-safe +- Marking operations are thread-safe +- Profiler control operations are process-wide + +Integration: + +- Compatible with HIP runtime +- Supports HSA (Heterogeneous System Architecture) +- Provides both C and C++ interfaces + +Performance Considerations: + +- Minimal overhead for marking and range operations +- Thread-local storage for efficient range stacking +- Lightweight profiler control mechanisms + +.. note:: + + All string parameters must be null-terminated. + +.. warning:: + + Proper nesting of range push/pop operations is the user's responsibility. + +This ROCTx API topic broadly covers: + +* :ref:`roctx_modules_reference` +* :ref:`global_roctx_data_structures_topics_files_reference` diff --git a/source/docs/api-reference/rocprofiler-sdk_api/modules/agent_information.rst b/source/docs/api-reference/rocprofiler-sdk_api/modules/agent_information.rst index cbaf66c6a8..fdad50f198 100644 --- a/source/docs/api-reference/rocprofiler-sdk_api/modules/agent_information.rst +++ b/source/docs/api-reference/rocprofiler-sdk_api/modules/agent_information.rst @@ -8,4 +8,5 @@ Agent Information ******************************************************************************* .. doxygengroup:: AGENTS + :project: rocprofiler-sdk :content-only: diff --git a/source/docs/api-reference/rocprofiler-sdk_api/modules/buffer_handling.rst b/source/docs/api-reference/rocprofiler-sdk_api/modules/buffer_handling.rst index d4072c5be3..5ceeb4f85b 100644 --- a/source/docs/api-reference/rocprofiler-sdk_api/modules/buffer_handling.rst +++ b/source/docs/api-reference/rocprofiler-sdk_api/modules/buffer_handling.rst @@ -9,3 +9,4 @@ Buffer handling .. doxygengroup:: BUFFER_HANDLING :content-only: + :project: rocprofiler-sdk diff --git a/source/docs/api-reference/rocprofiler-sdk_api/modules/buffer_tracing.rst b/source/docs/api-reference/rocprofiler-sdk_api/modules/buffer_tracing.rst index 00be074665..67642e8de2 100644 --- a/source/docs/api-reference/rocprofiler-sdk_api/modules/buffer_tracing.rst +++ b/source/docs/api-reference/rocprofiler-sdk_api/modules/buffer_tracing.rst @@ -9,3 +9,4 @@ Buffer tracing .. doxygengroup:: BUFFER_TRACING_SERVICE :content-only: + :project: rocprofiler-sdk diff --git a/source/docs/api-reference/rocprofiler-sdk_api/modules/callback_tracing.rst b/source/docs/api-reference/rocprofiler-sdk_api/modules/callback_tracing.rst index 1c5dd0318c..ff95cca79b 100644 --- a/source/docs/api-reference/rocprofiler-sdk_api/modules/callback_tracing.rst +++ b/source/docs/api-reference/rocprofiler-sdk_api/modules/callback_tracing.rst @@ -9,3 +9,4 @@ Callback tracing .. doxygengroup:: CALLBACK_TRACING_SERVICE :content-only: + :project: rocprofiler-sdk diff --git a/source/docs/api-reference/rocprofiler-sdk_api/modules/context_management.rst b/source/docs/api-reference/rocprofiler-sdk_api/modules/context_management.rst index e051c88f40..bdff9ebbce 100644 --- a/source/docs/api-reference/rocprofiler-sdk_api/modules/context_management.rst +++ b/source/docs/api-reference/rocprofiler-sdk_api/modules/context_management.rst @@ -9,3 +9,4 @@ Context management .. doxygengroup:: CONTEXT_OPERATIONS :content-only: + :project: rocprofiler-sdk diff --git a/source/docs/api-reference/rocprofiler-sdk_api/modules/counter_config.rst b/source/docs/api-reference/rocprofiler-sdk_api/modules/counter_config.rst index 9085ef9296..3b4f354b79 100644 --- a/source/docs/api-reference/rocprofiler-sdk_api/modules/counter_config.rst +++ b/source/docs/api-reference/rocprofiler-sdk_api/modules/counter_config.rst @@ -9,3 +9,4 @@ Counter config .. doxygengroup:: COUNTER_CONFIG :content-only: + :project: rocprofiler-sdk diff --git a/source/docs/api-reference/rocprofiler-sdk_api/modules/counters.rst b/source/docs/api-reference/rocprofiler-sdk_api/modules/counters.rst index 67ffd2e602..1026624b00 100644 --- a/source/docs/api-reference/rocprofiler-sdk_api/modules/counters.rst +++ b/source/docs/api-reference/rocprofiler-sdk_api/modules/counters.rst @@ -9,3 +9,4 @@ Counters .. doxygengroup:: COUNTERS :content-only: + :project: rocprofiler-sdk diff --git a/source/docs/api-reference/rocprofiler-sdk_api/modules/device_counting_service.rst b/source/docs/api-reference/rocprofiler-sdk_api/modules/device_counting_service.rst index 3a583de3b1..e879f5192d 100644 --- a/source/docs/api-reference/rocprofiler-sdk_api/modules/device_counting_service.rst +++ b/source/docs/api-reference/rocprofiler-sdk_api/modules/device_counting_service.rst @@ -9,3 +9,4 @@ Device counting service .. doxygengroup:: device_counting_service :content-only: + :project: rocprofiler-sdk diff --git a/source/docs/api-reference/rocprofiler-sdk_api/modules/dispatch_counting_service.rst b/source/docs/api-reference/rocprofiler-sdk_api/modules/dispatch_counting_service.rst index 559567d416..2be03026b7 100644 --- a/source/docs/api-reference/rocprofiler-sdk_api/modules/dispatch_counting_service.rst +++ b/source/docs/api-reference/rocprofiler-sdk_api/modules/dispatch_counting_service.rst @@ -9,3 +9,4 @@ Dispatch counting service .. doxygengroup:: dispatch_counting_service :content-only: + :project: rocprofiler-sdk diff --git a/source/docs/api-reference/rocprofiler-sdk_api/modules/external_correalation.rst b/source/docs/api-reference/rocprofiler-sdk_api/modules/external_correalation.rst index a23f479b94..d4f58e9e9d 100644 --- a/source/docs/api-reference/rocprofiler-sdk_api/modules/external_correalation.rst +++ b/source/docs/api-reference/rocprofiler-sdk_api/modules/external_correalation.rst @@ -9,3 +9,4 @@ External correlation .. doxygengroup:: EXTERNAL_CORRELATION :content-only: + :project: rocprofiler-sdk diff --git a/source/docs/api-reference/rocprofiler-sdk_api/modules/intercept_table.rst b/source/docs/api-reference/rocprofiler-sdk_api/modules/intercept_table.rst index 37abb76c1c..e56c73f5a4 100644 --- a/source/docs/api-reference/rocprofiler-sdk_api/modules/intercept_table.rst +++ b/source/docs/api-reference/rocprofiler-sdk_api/modules/intercept_table.rst @@ -9,3 +9,4 @@ Intercept table .. doxygengroup:: INTERCEPT_TABLE :content-only: + :project: rocprofiler-sdk diff --git a/source/docs/api-reference/rocprofiler-sdk_api/modules/internal_threading_management.rst b/source/docs/api-reference/rocprofiler-sdk_api/modules/internal_threading_management.rst index d08ea2dac8..a61372a1a2 100644 --- a/source/docs/api-reference/rocprofiler-sdk_api/modules/internal_threading_management.rst +++ b/source/docs/api-reference/rocprofiler-sdk_api/modules/internal_threading_management.rst @@ -9,3 +9,4 @@ Internal threading management .. doxygengroup:: INTERNAL_THREADING :content-only: + :project: rocprofiler-sdk diff --git a/source/docs/api-reference/rocprofiler-sdk_api/modules/ompt_registration.rst b/source/docs/api-reference/rocprofiler-sdk_api/modules/ompt_registration.rst index 5f63c43fd9..85e8d88564 100644 --- a/source/docs/api-reference/rocprofiler-sdk_api/modules/ompt_registration.rst +++ b/source/docs/api-reference/rocprofiler-sdk_api/modules/ompt_registration.rst @@ -9,3 +9,4 @@ OMPT Registration .. doxygengroup:: OMPT_REGISTRATION :content-only: + :project: rocprofiler-sdk diff --git a/source/docs/api-reference/rocprofiler-sdk_api/modules/pc_sampling_service.rst b/source/docs/api-reference/rocprofiler-sdk_api/modules/pc_sampling_service.rst index 547e01c9df..d4ac60180c 100644 --- a/source/docs/api-reference/rocprofiler-sdk_api/modules/pc_sampling_service.rst +++ b/source/docs/api-reference/rocprofiler-sdk_api/modules/pc_sampling_service.rst @@ -9,3 +9,4 @@ PC Sampling service .. doxygengroup:: PC_SAMPLING_SERVICE :content-only: + :project: rocprofiler-sdk diff --git a/source/docs/api-reference/rocprofiler-sdk_api/modules/thread_trace.rst b/source/docs/api-reference/rocprofiler-sdk_api/modules/thread_trace.rst index e0218b29d7..13959bcebb 100644 --- a/source/docs/api-reference/rocprofiler-sdk_api/modules/thread_trace.rst +++ b/source/docs/api-reference/rocprofiler-sdk_api/modules/thread_trace.rst @@ -9,3 +9,4 @@ Thread trace .. doxygengroup:: THREAD_TRACE :content-only: + :project: rocprofiler-sdk diff --git a/source/docs/api-reference/rocprofiler-sdk_api/modules/tool_registration.rst b/source/docs/api-reference/rocprofiler-sdk_api/modules/tool_registration.rst index eafd8b1b28..7dcfd72c46 100644 --- a/source/docs/api-reference/rocprofiler-sdk_api/modules/tool_registration.rst +++ b/source/docs/api-reference/rocprofiler-sdk_api/modules/tool_registration.rst @@ -9,3 +9,4 @@ Tool registration .. doxygengroup:: REGISTRATION_GROUP :content-only: + :project: rocprofiler-sdk diff --git a/source/docs/conf.py b/source/docs/conf.py index 61bd5272b5..c831768c22 100644 --- a/source/docs/conf.py +++ b/source/docs/conf.py @@ -65,10 +65,13 @@ extensions = [ doxygen_root = "." doxysphinx_enabled = True -doxygen_project = { - "name": "rocprofiler-sdk", - "path": "_doxygen/rocprofiler-sdk/xml", + +breathe_projects = { + "rocprofiler-sdk": "_doxygen/rocprofiler-sdk/xml", + "roctx": "_doxygen/roctx/xml", } +breathe_default_project = "rocprofiler-sdk" + doxyfile = "rocprofiler-sdk.dox" external_projects_current_project = "rocprofiler-sdk" @@ -81,6 +84,12 @@ external_toc_path = "./_toc.yml" # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] suppress_warnings = ["etoc.toctree"] +nitpick_ignore = [ + ("cpp:identifier", "uint32_t"), + ("cpp:identifier", "uint64_t"), + ("cpp:identifier", "hsa_agent_s"), + ("cpp:identifier", "ihipStream_t"), +] # -- Options for HTML output ------------------------------------------------- diff --git a/source/docs/index.rst b/source/docs/index.rst index 0c48f58ea0..e97737eba8 100644 --- a/source/docs/index.rst +++ b/source/docs/index.rst @@ -44,7 +44,7 @@ The documentation is structured as follows: * :doc:`Counter collection services ` * :doc:`PC sampling ` * :doc:`ROCprofiler-SDK API ` - * :doc:`ROCTx API library <_doxygen/roctx/html/index>` + * :doc:`ROCTx API ` .. grid-item-card:: Conceptual diff --git a/source/docs/rocprofiler-sdk-roctx.dox.in b/source/docs/rocprofiler-sdk-roctx.dox.in index e011d980d3..f677b04f6b 100644 --- a/source/docs/rocprofiler-sdk-roctx.dox.in +++ b/source/docs/rocprofiler-sdk-roctx.dox.in @@ -152,18 +152,20 @@ EXCLUDE_PATTERNS = */.git/* \ @SOURCE_DIR@/**/rocprofiler-sdk/**/* \ @SOURCE_DIR@/**/rocprofiler-sdk-roctx/api_trace.h EXCLUDE_SYMBOLS = "std::*" \ - "ROCTX_ATTRIBUTE" \ + "ROCPROFILER_ATTRIBUTE" \ + "ROCPROFILER_API" \ + "ROCPROFILER_NONNULL" \ + "ROCPROFILER_PUBLIC_API" \ + "ROCPROFILER_HIDDEN_API" \ + "ROCPROFILER_EXPORT_DECORATOR" \ + "ROCPROFILER_IMPORT_DECORATOR" \ + "ROCPROFILER_EXPORT" \ + "ROCPROFILER_IMPORT" \ + "ROCPROFILER_HANDLE_LITERAL" \ + "ROCPROFILER_EXTERN_C_INIT" \ + "ROCPROFILER_EXTERN_C_FINI" \ "ROCTX_API" \ - "ROCTX_NONNULL" \ - "ROCTX_PUBLIC_API" \ - "ROCTX_HIDDEN_API" \ - "ROCTX_EXPORT_DECORATOR" \ - "ROCTX_IMPORT_DECORATOR" \ - "ROCTX_EXPORT" \ - "ROCTX_IMPORT" \ - "ROCTX_HANDLE_LITERAL" \ - "ROCTX_EXTERN_C_INIT" \ - "ROCTX_EXTERN_C_FINI" + "ROCTX_NONNULL" EXAMPLE_PATH = @SOURCE_DIR@/samples EXAMPLE_PATTERNS = *.h \ *.hh \ diff --git a/source/docs/rocprofiler-sdk.dox.in b/source/docs/rocprofiler-sdk.dox.in index 8292939eb4..605bd16316 100644 --- a/source/docs/rocprofiler-sdk.dox.in +++ b/source/docs/rocprofiler-sdk.dox.in @@ -169,7 +169,9 @@ EXCLUDE_SYMBOLS = "std::*" \ "ROCPROFILER_EXTERN_C_FINI" \ "ROCPROFILER_SDK_DEPRECATED_WARNINGS" \ "ROCPROFILER_SDK_EXPERIMENTAL_WARNINGS" \ - "ROCPROFILER_*_LAST" + "ROCPROFILER_*_LAST" \ + "ROCTX_API" \ + "ROCTX_NONNULL" EXAMPLE_PATH = @SOURCE_DIR@/samples EXAMPLE_PATTERNS = *.h \ *.hh \ diff --git a/source/include/rocprofiler-sdk-roctx/defines.h b/source/include/rocprofiler-sdk-roctx/defines.h index afef022e38..7569ca1d0c 100644 --- a/source/include/rocprofiler-sdk-roctx/defines.h +++ b/source/include/rocprofiler-sdk-roctx/defines.h @@ -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. * * @{ diff --git a/source/include/rocprofiler-sdk-roctx/roctx.h b/source/include/rocprofiler-sdk-roctx/roctx.h index 0f33a34f9f..5845882af8 100644 --- a/source/include/rocprofiler-sdk-roctx/roctx.h +++ b/source/include/rocprofiler-sdk-roctx/roctx.h @@ -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. diff --git a/source/include/rocprofiler-sdk-roctx/types.h b/source/include/rocprofiler-sdk-roctx/types.h index 3862780452..ffd91df454 100644 --- a/source/include/rocprofiler-sdk-roctx/types.h +++ b/source/include/rocprofiler-sdk-roctx/types.h @@ -26,9 +26,9 @@ #include -/** @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 * * @{ */