Fix documentation (#949)

README.md

@@ -5,7 +5,7 @@ Note: rocprofiler-sdk is currently considered a beta version and is subject to c
 
 ## Overview
 
-ROCProfiler-SDK is AMD’s new and improved tooling infrastructure, providing a hardware-specific low-level performance analysis interface for profiling and tracing GPU compute applications. To see what's changed [Click Here](source/docs/about.md)
+ROCProfiler-SDK is AMD’s new and improved tooling infrastructure, providing a hardware-specific low-level performance analysis interface for profiling and tracing GPU compute applications. To see what's changed [Click Here](source/docs/index.md)
 
 ## GPU Metrics
 
@@ -55,7 +55,7 @@ To install ROCprofiler, run:
 cmake --build rocprofiler-sdk-build --target install
 ```
 
-Please see the detailed section on build and installation here: [Click Here](/source/docs/installation.md)
+Please see the detailed section on build and installation here: [Click Here](source/docs/installation.md)
 
 ## Support
 

source/include/rocprofiler-sdk/agent_profile.h

@@ -81,7 +81,6 @@ typedef void (*rocprofiler_agent_profile_callback_t)(
  * @param [in] cb Callback called when the context is started for the tool to specify what
  * counters to collect (rocprofiler_profile_config_id_t).
  * @param [in] user_data User supplied data to be passed to the callback cb when triggered
- * @param [in] config_id Profile config detailing the counters to collect for this kernel
  * @return ::rocprofiler_status_t
  * @retval ::ROCPROFILER_STATUS_ERROR_CONTEXT_INVALID Returned if the context does not exist.
  * @retval ::ROCPROFILER_STATUS_ERROR_BUFFER_NOT_FOUND Returned if the buffer is not found.

source/include/rocprofiler-sdk/amd_detail/thread_trace_core.h

@@ -114,8 +114,9 @@ typedef rocprofiler_status_t (*rocprofiler_att_parser_isa_callback_t)(char*
  * @param[in] userdata Arbitrary data pointer to be sent back to the user via callback.
  * @returns Number of bytes remaining in shader engine.
  * @retval 0 if no more SE data is available. Parsing will stop.
+ * @retval ret Where 0 > ret > buffer_size for partially filled buffer, and caller moves over to
+ * next SE.
  * @retval buffer_size if the buffer does not hold enough data for the current shader engine.
- * @retval 0 > ret > buffer_size for partially filled buffer, and caller moves over to next SE.
  */
 typedef uint64_t (*rocprofiler_att_parser_se_data_callback_t)(int*      shader_engine_id,
                                                               uint8_t** buffer,

source/include/rocprofiler-sdk/pc_sampling.h

@@ -142,7 +142,7 @@ typedef struct
     /// @brief A unit used to specify the interval of the @ref method for samples generation.
     /// @var min_interval
     /// @brief the highest possible frequencey for generating samples using @ref method.
-    /// @var max_interva
+    /// @var max_interval
     /// @brief the lowest possible frequency for generating samples using @ref method
 
 } rocprofiler_pc_sampling_configuration_t;
@@ -248,25 +248,25 @@ typedef struct
 {
     uint64_t                            size;  ///< Size of this struct
     rocprofiler_pc_sampling_header_v1_t flags;
-    uint8_t                             chiplet;  /// chiplet index
-    uint8_t                             wave_id;  /// wave identifier within the workgroup
+    uint8_t                             chiplet;  ///< chiplet index
+    uint8_t                             wave_id;  ///< wave identifier within the workgroup
     uint8_t                             wave_issued : 1;
-    uint8_t                             reserved    : 7;  /// reserved 7 bits, must be zero
-    uint32_t                            hw_id;            /// compute unit identifier
-    uint64_t                     pc;  /// Program counter of the wave of the moment of interruption
+    uint8_t                             reserved    : 7;  ///< reserved 7 bits, must be zero
+    uint32_t                            hw_id;            ///< compute unit identifier
+    uint64_t                     pc;  ///< Program counter of the wave of the moment of interruption
     uint64_t                     exec_mask;
-    rocprofiler_dim3_t           workgroup_id;  /// wave coordinates within the workgroup
+    rocprofiler_dim3_t           workgroup_id;  ///< wave coordinates within the workgroup
     uint32_t                     wave_count;
-    uint64_t                     timestamp;  /// timestamp when sample is generated
+    uint64_t                     timestamp;  ///< timestamp when sample is generated
     rocprofiler_correlation_id_t correlation_id;
     rocprofiler_pc_sampling_snapshot_v1_t
-             snapshot;   /// @see ::rocprofiler_pc_sampling_snapshot_v1_t
-    uint32_t reserved2;  /// for future use
+             snapshot;   ///< @see ::rocprofiler_pc_sampling_snapshot_v1_t
+    uint32_t reserved2;  ///< for future use
 
     /// @var flags
     /// @brief indicates what fields of this struct are meaningful for the represented sample.
     /// The values depend on what the underlying GPU agent architecture supports.
-    /// @var wave_issue
+    /// @var wave_issued
     /// @brief indicates whether the wave is issueing the instruction represented by the @ref pc
     /// @var exec_mask
     /// @brief shows how many SIMD lanes of the wave were executing the instruction

source/include/rocprofiler-sdk/profile_config.h

@@ -49,7 +49,7 @@ ROCPROFILER_EXTERN_C_INIT
  * @param [in] agent_id Agent identifier
  * @param [in] counters_list List of GPU counters
  * @param [in] counters_count Size of counters list
- * @param [in/out] config_id Identifier for GPU counters group. If an existing
+ * @param [in,out] config_id Identifier for GPU counters group. If an existing
                    profile is supplied, that profiles counters will be copied
                    over to a new profile (returned via this id)
  * @return ::rocprofiler_status_t