Как задокументировать значение ошибки с помощью Doxygen?

У меня есть функция, которая устанавливает errno при возникновении ошибки. Я хочу задокументировать возможные значения errno. Но похоже, что Doxygen поддерживает только исключения, а не errno. Можно ли задокументировать errno значения, такие как справочная страница Linux?


c doxygen
person UltimaWeapon    schedule 22.05.2014    source источник

Ответы (2)


arrow_upward
2
arrow_downward

Doxygen явно не поддерживает документирование значений errno. Следовательно, я бы использовал возможность уценки Doxygen для создания таблицы с отступом:

/**
 * ...
 * Errno values:
 * ~~~
 * Value  | Meaning
 * ------ | ----------------
 * EINVAL | Invalid argument
 * ~~~
 */
person Steve Emmerson    schedule 22.05.2014

arrow_upward
2
arrow_downward

На самом деле вы устанавливаете 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
 */
person David Costa    schedule 17.05.2015