From 4c2dec5bb893392230717180ba98e725c9dd7ee4 Mon Sep 17 00:00:00 2001 From: David Yat Sin Date: Mon, 7 Jul 2025 21:44:29 +0000 Subject: [PATCH] doc: Fix doxygen comments for in-out params --- runtime/hsa-runtime/core/inc/amd_gpu_agent.h | 10 +++++----- .../image/addrlib/src/core/addrcommon.h | 2 +- .../image/addrlib/src/core/addrlib2.cpp | 4 ++-- runtime/hsa-runtime/inc/hsa_ext_amd.h | 2 +- runtime/hsa-runtime/inc/hsa_ven_amd_aqlprofile.h | 14 +++++++------- 5 files changed, 16 insertions(+), 16 deletions(-) diff --git a/runtime/hsa-runtime/core/inc/amd_gpu_agent.h b/runtime/hsa-runtime/core/inc/amd_gpu_agent.h index 8cd55e95c6..f7dd5d26c6 100644 --- a/runtime/hsa-runtime/core/inc/amd_gpu_agent.h +++ b/runtime/hsa-runtime/core/inc/amd_gpu_agent.h @@ -107,26 +107,26 @@ class GpuAgentInt : public core::Agent { // @brief Carve scratch memory for main from scratch pool. // - // @param [in/out] scratch Structure to be populated with the carved memory + // @param [in,out] scratch Structure to be populated with the carved memory // information. virtual void AcquireQueueMainScratch(ScratchInfo &scratch) = 0; // @brief Carve scratch memory for alt from scratch pool. // - // @param [in/out] scratch Structure to be populated with the carved memory + // @param [in,out] scratch Structure to be populated with the carved memory // information. virtual void AcquireQueueAltScratch(ScratchInfo &scratch) = 0; // @brief Release scratch memory from main back to scratch pool. // - // @param [in/out] scratch Scratch memory previously acquired with call to + // @param [in,out] scratch Scratch memory previously acquired with call to // ::AcquireQueueMainScratch. virtual void ReleaseQueueMainScratch(ScratchInfo &base) = 0; // @brief Release scratch memory back from alternate to scratch pool. // - // @param [in/out] scratch Scratch memory previously acquired with call to - // ::AcquireQueueAltcratch. + // @param [in,out] scratch Scratch memory previously acquired with call to + // ::AcquireQueueAltScratch. virtual void ReleaseQueueAltScratch(ScratchInfo &base) = 0; // @brief Translate the kernel start and end dispatch timestamp from agent diff --git a/runtime/hsa-runtime/image/addrlib/src/core/addrcommon.h b/runtime/hsa-runtime/image/addrlib/src/core/addrcommon.h index 8948925747..884f4d598e 100644 --- a/runtime/hsa-runtime/image/addrlib/src/core/addrcommon.h +++ b/runtime/hsa-runtime/image/addrlib/src/core/addrcommon.h @@ -1021,7 +1021,7 @@ static inline UINT_32 GetCoordActiveMask( **************************************************************************************************** */ static inline void FillEqBitComponents( - ADDR_EQUATION *pEquation) // [in/out] Equation to calculate bit components for + ADDR_EQUATION *pEquation) // [in,out] Equation to calculate bit components for { pEquation->numBitComponents = 1; // We always have at least the address for (UINT_32 xorN = 1; xorN < ADDR_MAX_EQUATION_COMP; xorN++) diff --git a/runtime/hsa-runtime/image/addrlib/src/core/addrlib2.cpp b/runtime/hsa-runtime/image/addrlib/src/core/addrlib2.cpp index 43d4c0f9db..0c1e31e4ba 100644 --- a/runtime/hsa-runtime/image/addrlib/src/core/addrlib2.cpp +++ b/runtime/hsa-runtime/image/addrlib/src/core/addrlib2.cpp @@ -1049,8 +1049,8 @@ ADDR_E_RETURNCODE Lib::ApplyCustomizedPitchHeight( const ADDR2_COMPUTE_SURFACE_INFO_INPUT* pIn, ///< [in] input structure UINT_32 elementBytes, ///< [in] element bytes per element UINT_32 pitchAlignInElement, ///< [in] pitch alignment in element - UINT_32* pPitch, ///< [in/out] pitch - UINT_32* pHeight ///< [in/out] height + UINT_32* pPitch, ///< [in,out] pitch + UINT_32* pHeight ///< [in,out] height ) const { ADDR_E_RETURNCODE returnCode = ADDR_OK; diff --git a/runtime/hsa-runtime/inc/hsa_ext_amd.h b/runtime/hsa-runtime/inc/hsa_ext_amd.h index 08c8dededa..c402a51264 100644 --- a/runtime/hsa-runtime/inc/hsa_ext_amd.h +++ b/runtime/hsa-runtime/inc/hsa_ext_amd.h @@ -3153,7 +3153,7 @@ hsa_status_t hsa_amd_spm_release(hsa_agent_t preferred_agent); * * @param[in] size_in_bytes size of the buffer * - * @param[in/out] timeout timeout in milliseconds + * @param[in,out] timeout timeout in milliseconds * * @param[out] size_copied number of bytes copied * diff --git a/runtime/hsa-runtime/inc/hsa_ven_amd_aqlprofile.h b/runtime/hsa-runtime/inc/hsa_ven_amd_aqlprofile.h index 0022c0d8b8..a49221c49e 100644 --- a/runtime/hsa-runtime/inc/hsa_ven_amd_aqlprofile.h +++ b/runtime/hsa-runtime/inc/hsa_ven_amd_aqlprofile.h @@ -267,21 +267,21 @@ typedef struct { // Only 'pm4_command' fields of the packet are set and the application // is responsible to set Vendor Specific header type a completion signal hsa_status_t hsa_ven_amd_aqlprofile_start( - hsa_ven_amd_aqlprofile_profile_t* profile, // [in/out] profile contex object + hsa_ven_amd_aqlprofile_profile_t* profile, // [in,out] profile context object hsa_ext_amd_aql_pm4_packet_t* aql_start_packet); // [out] profile start AQL packet // Method to populate the provided AQL packet with profiling stop commands // Only 'pm4_command' fields of the packet are set and the application // is responsible to set Vendor Specific header type and a completion signal hsa_status_t hsa_ven_amd_aqlprofile_stop( - const hsa_ven_amd_aqlprofile_profile_t* profile, // [in] profile contex object + const hsa_ven_amd_aqlprofile_profile_t* profile, // [in] profile context object hsa_ext_amd_aql_pm4_packet_t* aql_stop_packet); // [out] profile stop AQL packet // Method to populate the provided AQL packet with profiling read commands // Only 'pm4_command' fields of the packet are set and the application // is responsible to set Vendor Specific header type and a completion signal hsa_status_t hsa_ven_amd_aqlprofile_read( - const hsa_ven_amd_aqlprofile_profile_t* profile, // [in] profile contex object + const hsa_ven_amd_aqlprofile_profile_t* profile, // [in] profile context object hsa_ext_amd_aql_pm4_packet_t* aql_read_packet); // [out] profile stop AQL packet // Legacy devices, PM4 profiling packet size @@ -293,7 +293,7 @@ hsa_status_t hsa_ven_amd_aqlprofile_legacy_get_pm4( // Method to add a marker (correlation ID) into the ATT buffer. hsa_status_t hsa_ven_amd_aqlprofile_att_marker( - hsa_ven_amd_aqlprofile_profile_t* profile, // [in/out] profile contex object + hsa_ven_amd_aqlprofile_profile_t* profile, // [in,out] profile context object hsa_ext_amd_aql_pm4_packet_t* aql_marker_packet, // [out] profile marker AQL packet uint32_t data, // [in] Data to be inserted hsa_ven_amd_aqlprofile_att_marker_channel_t channel); // [in] Comm channel @@ -345,19 +345,19 @@ typedef enum { typedef hsa_status_t (*hsa_ven_amd_aqlprofile_data_callback_t)( hsa_ven_amd_aqlprofile_info_type_t info_type, // [in] data type, PMC or trace data hsa_ven_amd_aqlprofile_info_data_t* info_data, // [in] info_data object - void* callback_data); // [in/out] data passed to the callback + void* callback_data); // [in,out] data passed to the callback // Method for getting the profile info hsa_status_t hsa_ven_amd_aqlprofile_get_info( const hsa_ven_amd_aqlprofile_profile_t* profile, // [in] profile context object hsa_ven_amd_aqlprofile_info_type_t attribute, // [in] requested profile attribute - void* value); // [in/out] returned value + void* value); // [in,out] returned value // Method for iterating the events output data hsa_status_t hsa_ven_amd_aqlprofile_iterate_data( const hsa_ven_amd_aqlprofile_profile_t* profile, // [in] profile context object hsa_ven_amd_aqlprofile_data_callback_t callback, // [in] callback to iterate the output data - void* data); // [in/out] data passed to the callback + void* data); // [in,out] data passed to the callback // Return error string hsa_status_t hsa_ven_amd_aqlprofile_error_string(