Документация по функциям, дублированная на прототипы в заголовочных файлах C ++ -> Doxygen

Question

Doxygen повторяет документацию по функциям, когда встречает прототипы функций в заголовочные файлы, например:

код:

#include <File main.h>

void Func1(void);


///File main.c:

#include <main.h>

/*! Main program entry point. */
main()
{
    Func1();
}

/*! Test function which does nothing. */
void Func1(void)
{
    return;
}

генерирует две партии документации для Func1 (): первая в main.c документация, а вторая в main.h документации. С большим проектом, это почти удваивает размер документации с повторным, избыточным функциональная документация. Это ошибка или какая-то проблема конфигурации?

Answer 1

Если вы установите EXTRACT_ALL на NO и только документируете свои файлы заголовков, используя (/** @file */), тогда doxygen будет показывать только заголовки и по-прежнему включать документацию, найденную в определении функции.

Есливы документируете заголовок и исходный файл или устанавливаете EXTRACT_ALL в YES, тогда doxygen покажет документацию по функции как часть заголовка и как часть документации по исходному файлу.Это особенность, а не ошибка: -)

Answer 2

Настройка doxygen для группировки свободных функций по пространству имен, а не по файлу.

Answer 3

Вы должны продублировать прототип функции, а не реализацию.Но, возможно, установка HIDE_UNDOC_MEMBERS на YES может решить вашу проблему.