Имам функция, която задава errno при възникване на грешка. Искам да документирам възможните errno стойности. Но изглежда, че Doxygen поддържа само изключение, а не errno. Възможно ли е да се документират errno стойности като страница с ръководство за Linux?
Как да документирам errno стойност с Doxygen?
Отговори (2)
Doxygen не изглежда изрично да поддържа документиране на errno стойности. Следователно бих използвал възможността за маркиране на Doxygen, за да създам таблица с отстъп:
/**
* ...
* Errno values:
* ~~~
* Value | Meaning
* ------ | ----------------
* EINVAL | Invalid argument
* ~~~
*/
person
Steve Emmerson
schedule
22.05.2014
Вие всъщност задавате 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
