Документация дубликатов Doxygen от @file и @defgroup

Я использую Doxygen для документирования проекта. В одном файле у меня есть куча открытых функций, которые я хочу поместить в группу. Я делаю это следующим образом:

/**
    @file myFile.c
    @brief This is a file. It has stuff.
*/
/**
    @defgroup my_group Group with myFile.c stuff
    @{
*/

//CODE & STUFF WITH DOCUMENTATION

/**
   @}
*/

Проблема в том, что вывод LaTeX содержит всю документацию здесь дважды; один раз в разделе "Документация модуля" и еще раз в разделе "Документация файла". Это может быть около 25 страниц полностью дублированного материала в моем конечном PDF-файле (сгенерированном из LaTeX).

Идеальным решением было бы, чтобы в Файловой документации для myFile.c было написано "See @ref my_group" или что-то в этом роде. Есть ли способ сделать это в Doxygen?

1 ответ

Решение

Приемлемое решение найдено:

  1. Создайте XML-файл макета Doxygen и настройте его для использования ( инструкции)
  2. Откройте файл XML; Найти <group> тег; закомментировать <detaileddescription> а также <memberdef> разделы

В результате в "Документации модуля" был создан только список членов с гиперссылками на полную документацию членов в разделе "Файловая документация" в выводе LaTeX/PDF. Вывод HTML уже функционировал таким образом, поэтому он не претерпел существенных изменений.

Другие вопросы по тегам