如何用Doxygen记录errno值？

Question

我有一个函数在发生错误时设置errno。我想记录可能的errno值。但似乎Doxygen只支持异常，而不是errno。是否可以记录Linux man page之类的errno值？

Answer 1

Doxygen似乎并不明确支持记录errno值。因此，我会使用Doxygen的降价功能来创建缩进表：

/**
 * ...
 * Errno values:
 * ~~~
 * Value  | Meaning
 * ------ | ----------------
 * EINVAL | Invalid argument
 * ~~~
 */

Answer 2

你实际上在发生错误时设置了errno，所以作为一种解决方法，你可以使用“exception”部分来记录这样的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
 */