2015-04-09 5 views
0

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

/** 
    @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 говорила: «См. @ref my_group» или что-то в этом роде. Есть ли способ сделать это в Doxygen?

ответ

0

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

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

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

 Смежные вопросы

  • Нет связанных вопросов^_^