SWDEV-290704 - Add doxygen in hiprtc

Change-Id: Ib1efb6874472601c0f45fc5c7f85a01e69b0a958


[ROCm/clr commit: 1936678084]
Tento commit je obsažen v:
Julia Jiang
2021-06-10 17:21:25 -04:00
rodič 50a4684ada
revize e3253b830d
+28 -2
Zobrazit soubor
@@ -22,6 +22,12 @@ THE SOFTWARE.
#ifndef HIPRTC_H
#define HIPRTC_H
/**
* @addtogroup Runtime Runtime Compilation
* @{
* @ingroup Runtime
*/
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
@@ -32,6 +38,12 @@ extern "C" {
#pragma GCC visibility push (default)
#endif
/*
* @brief hiprtcResult
* @enum
*
*/
enum hiprtcResult {
HIPRTC_SUCCESS = 0,
HIPRTC_ERROR_OUT_OF_MEMORY = 1,
@@ -47,8 +59,19 @@ enum hiprtcResult {
HIPRTC_ERROR_INTERNAL_ERROR = 11
};
const char* hiprtcGetErrorString(hiprtcResult result);
/**
* @brief Return text string message to explain the error which occurred
*
* @param [in] hiprtcResult result code to convert to string.
* @return const char pointer to the NULL-terminated error string
*
* @warning In HIP, this function returns the name of the error,
* if the hiprtc result is defined, it will return "Invalid HIPRTC error code"
*
* @see hiprtcResult
*/
const char* hiprtcGetErrorString(hiprtcResult result);
hiprtcResult hiprtcVersion(int* major, int* minor);
@@ -90,5 +113,8 @@ hiprtcResult hiprtcGetCodeSize(hiprtcProgram prog, size_t* codeSizeRet);
#ifdef __cplusplus
}
#endif /* __cplusplus */
// doxygen end HIPrtc feature
/**
* @}
*/
#endif //HIPRTC_H