AI/rocm-systems
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doxygen Improvements (#170)

Browse Source 
* Doxygen updates

- Fix multiple @param where [in]/[out] was misplaced
- Fix @return
- Insert @retval
- Separate out installing conda environment from build docs step

[ROCm/rocprofiler-sdk commit: 14373c57be]
This commit is contained in:
Jonathan R. Madsen
2023-11-01 15:31:15 -05:00
committed by GitHub
parent 57ed1bcfd3
commit 1e2a80ef8e
10 changed files with 83 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files
projects/rocprofiler-sdk/source/include/rocprofiler/internal_threading.h
+4 -4
View File
@@ -71,12 +71,12 @@ typedef void (*rocprofiler_internal_thread_library_cb_t)(rocprofiler_internal_th
* caller is responsible for ignoring these callbacks if they want to ignore them beyond a certain
* point in the application.
*
* @param precreate [in] Callback invoked immediately before a new internal thread is created
* @param postcreate [in] Callback invoked immediately after a new internal thread is created
* @param libs [in] Bitwise-or of libraries, e.g. `ROCPROFILER_LIBRARY | ROCPROFILER_MARKER_LIBRARY`
* @param [in] precreate Callback invoked immediately before a new internal thread is created
* @param [in] postcreate Callback invoked immediately after a new internal thread is created
* @param [in] libs Bitwise-or of libraries, e.g. `ROCPROFILER_LIBRARY | ROCPROFILER_MARKER_LIBRARY`
* means the callbacks will be invoked whenever rocprofiler and/or the marker library create
* internal threads but not when the HSA or HIP libraries create internal threads.
* @param data [in] Data shared between callbacks
* @param [in] data Data shared between callbacks
*/
rocprofiler_status_t ROCPROFILER_API
rocprofiler_at_internal_thread_create(rocprofiler_internal_thread_library_cb_t precreate,