LINUX.ORG.RU

Doxygen(errno)


0

0

Честно гуглил и смотрел FAQ, наколлекционировал закладок на странички.

Впервые за много лет кодирования начал писать doxygen-документацию в программе, а не писать документацию в отдельной доке. Худо-бедно ковыряюсь, но!.. при документировании функции сразу наткнулся на проблему. Как выделить секцию с описанием кодов ошибок (errno)? Типа как "Errors" в манах. Никак ни тег не найду ни пример.

Спасибо.

PS Ежели ссылки есть, с радостью приму в дар.

http://www.stack.nl/~dimitri/doxygen/custcmd.html

Алиасы: что мешает ввести свой?

А вообще это нафиг не нужно. Я делаю так, например:

/** 
    @brief Delete a record with name from group gname 
    @param pconfdt Conf file structure
    @param[in] Group name
    @param[in] Record name
    @return Error code:
    - CONFDT_OK if success
    - CONFDT_DELETE_NO_REC if no such a record was found

    Deletes a record from confdt structure and frees necessary
    memory. It does nothing if such a record does not exist but
    returns an error code in this case.
*/
int confdt_del_rec( confdt_t* pconfdt, const char* gname, const char* name)

atoku ★★★
()
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.