У мя щас задача полностью продокументировать один модуль. Использую доксиген 1.5.1. Довольно прятная штука, но иногда непонятно, что она от меня хочет.

Итак: включил режим ворнингов, что бы он ругался на все недокументированые функции — дабы ничего не забыть. Так же мне нужна полная дока, разбитая по подмодулям, а так же по файлам (что в каком файле находится).

Далее... Есть некоторая функция... кусок хедера:

/**
 * @brief Print the term
 * описание
 * @ingroup grp_print
 */
bool printATerm(...);

Так же есть синшик с реализацией (но без комментария):

bool printATerm(...)

оба файла находятся в доксигеновской группе: grp_print

Итак проблема в сгенерированой доке:
на страничке, которая описывает группу grp_print имеем полное описание функции, т.е. тут все круто.
На страничке, которая описывает хедер делает линку на описание функции на страничку группы. В общем покатит.
На страничке, которая описывает срр-шник линки на описание нет. Так же имеем ворнинг при генерации, что мол функция не документирована (хотя она полностью документирована в хедере).
На страничке, которая показывает код хедера в объявлении функции имеем линку на метод одного из классов с тем же именем (метода, а не класса). Т.е. линка совсем не туда.

Как мне правильно разрулить данную ситуацию? Код можно слегка подправить, если нужно...

Здравствуйте, Graf Alex, Вы писали:

> Как мне правильно разрулить данную ситуацию?
Обычная практика — скармливать доксигену только хедеры.

Здравствуйте, spine, Вы писали:

S>Здравствуйте, Graf Alex, Вы писали:

>> Как мне правильно разрулить данную ситуацию?
S>Обычная практика — скармливать доксигену только хедеры.
Верю... но тут задача так же и срр-шники продоксигенить — мол какая функция в каком файле реализована.
А доксиген если видит хотя бы один комментарий в файле (например ключевое слово @file) он начинает ругаться на все недокументированые сущности в этом файле...

ЗЫ Пока разрулил методом прилепления еще одного описания к функции со ссылкой на страничку с более детальным описанием. Правда на той странице это описание приходится руками искать — туда куда нужно не прыгает....

Здравствуйте, Graf Alex,

Здравствуйте, Graf Alex,

Ну тогда возможно тебя спасет такая конструкция:

#ifndef DOXYGEN_SHOULD_SKIP_THIS

/* code that must be skipped by Doxygen */

#endif /* DOXYGEN_SHOULD_SKIP_THIS */

Здравствуйте, spine, Вы писали:

S>Здравствуйте, Graf Alex,

S>Здравствуйте, Graf Alex,

S>Ну тогда возможно тебя спасет такая конструкция:

S>

S>#ifndef DOXYGEN_SHOULD_SKIP_THIS

S>/* code that must be skipped by Doxygen */

S>#endif /* DOXYGEN_SHOULD_SKIP_THIS */
S>

Возможно... Но тогда возникает проблема непонимания кода