From 69fb9ee3aa00c05bcf4cafee246a1cab8fce2e46 Mon Sep 17 00:00:00 2001 From: Aditya Atluri Date: Wed, 31 Aug 2016 10:18:46 -0500 Subject: [PATCH] added doxygen comments for hipModuleLaunchKernel Change-Id: I8a52d2e62f4b7eea8e05d779b9fda49f0ac45130 --- include/hcc_detail/hip_runtime_api.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/include/hcc_detail/hip_runtime_api.h b/include/hcc_detail/hip_runtime_api.h index adf72d3196..0114a0772b 100644 --- a/include/hcc_detail/hip_runtime_api.h +++ b/include/hcc_detail/hip_runtime_api.h @@ -1213,7 +1213,10 @@ hipError_t hipModuleLoadData(hipModule_t *module, const void *image); * @param [in] kernelParams * @param [in] extraa * + * The function takes the above arguments and run the kernel in hipFunction_t f. with launch parameters specified in gridDimX, gridDimY, gridDimZ, blockDimX, blockDimY and blockDimmZ. The amount of shared memory is specificed and can be used with HIP_DYNAMIC_SHARED. The arguemt extra is used to pass in the arguments for the kernel. * @returns hipSuccess, hipInvalidDevice, hipErrorNotInitialized, hipErrorInvalidValue + * + * @warning kernellParams argument is not yet implemented in HIP. Please use extra instead. Please refer to hip_porting_driver_api.md for sample usage. */ hipError_t hipModuleLaunchKernel(hipFunction_t f, unsigned int gridDimX,