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
2025-05-23 04:38:55 +05:30
parent 7045a4c689
commit b48fa532bc
32 changed files with 240 additions and 24 deletions
@@ -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`
+
@@ -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
@@ -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`
+
@@ -0,0 +1,12 @@
+.. meta::
+  :description: Markers Information reference page.
+
+.. _markers_information_reference:
+
+*******************************************************************************
+Markers Information
+*******************************************************************************
+
+.. doxygengroup:: marker_group
+   :content-only:
+   :project: roctx
@@ -0,0 +1,12 @@
+.. meta::
+  :description: Naming utilities Information reference page.
+
+.. _naming-utilities_information_reference:
+
+*******************************************************************************
+Naming Information
+*******************************************************************************
+
+.. doxygengroup:: UTILITIES
+   :content-only:
+   :project: roctx
@@ -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
@@ -0,0 +1,12 @@
+.. meta::
+  :description: Ranges Information reference page.
+
+.. _ranges_information_reference:
+
+*******************************************************************************
+Ranges Information
+*******************************************************************************
+
+.. doxygengroup:: range_group
+   :content-only:
+   :project: roctx