SWDEV-391878 - Add missing hipInit documentation

Change-Id: Ib82328c844db2cd24c18d9199cb27abd115ceb51
ROCm · Jul 19, 2023 · 0ce8296 · 0ce8296
1 parent 7a7eeec
commit 0ce8296
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/include/hip/hip_runtime_api.h b/include/hip/hip_runtime_api.h
@@ -1367,8 +1367,11 @@ typedef struct hipArrayMapInfo {
  *
  * Most HIP APIs implicitly initialize the HIP runtime.
  * This API provides control over the timing of the initialization.
+ *
+ * @param [in] flags Flags to init HIP runtime with, currently it must be 0
+ *
+ * @returns #hipSuccess, #hipErrorInvalidValue
  */
-// TODO-ctx - more description on error codes.
 hipError_t hipInit(unsigned int flags);
 /**
  * @brief Returns the approximate HIP driver version.