C 如何使用Doxygen记录errno值?
我有一个函数,可以在发生错误时设置C 如何使用Doxygen记录errno值?,c,doxygen,C,Doxygen,我有一个函数,可以在发生错误时设置errno。我想记录可能的errno值。但似乎Doxygen只支持异常,而不支持errno。是否可以记录errno值,如?Doxygen似乎不明确支持记录errno值。因此,我将使用Doxygen的降价功能创建缩进表: /** * ... * Errno values: * ~~~ * Value | Meaning * ------ | ---------------- * EINVAL | Invalid argument * ~~~ */
errno
。我想记录可能的errno
值。但似乎Doxygen只支持异常,而不支持errno
。是否可以记录errno
值,如?Doxygen似乎不明确支持记录errno
值。因此,我将使用Doxygen的降价功能创建缩进表:
/**
* ...
* Errno values:
* ~~~
* Value | Meaning
* ------ | ----------------
* EINVAL | Invalid argument
* ~~~
*/
Doxygen似乎不明确支持记录
errno
值。因此,我将使用Doxygen的降价功能创建缩进表:
/**
* ...
* Errno values:
* ~~~
* Value | Meaning
* ------ | ----------------
* EINVAL | Invalid argument
* ~~~
*/
当发生错误时,您实际上设置了errno,因此作为一种解决方法,您可以使用“异常”部分记录errno值,如下所示:
/**
* function description
* \returns 0 if everything's okay
* \returns -1 if something went wrong and set `errno` accordingly. See exceptions below.
* \exception EINVAL wrong parameter was provided
*/
当发生错误时,您实际上设置了errno,因此作为一种解决方法,您可以使用“异常”部分记录errno值,如下所示:
/**
* function description
* \returns 0 if everything's okay
* \returns -1 if something went wrong and set `errno` accordingly. See exceptions below.
* \exception EINVAL wrong parameter was provided
*/