LINUX.ORG.RU

Документация Doxygen с индексом по проектам

 , ,


0

1

У меня есть несколько C++ проектов, связанных друг с другом. Код располагается примерно так:

/main/src
/idk/src
/device_module/device1/src
/device_module/device50/src
/control_panel/src
/logging/src
...
/doxygen_documentation <-- Здесь Doxyfile, здесь запускаю Doxygen

Мне нужно сгенерировать документацию так, чтобы на титульной странице были ссылки на проекты, и на страницах проектов был перечень только тех классов, которые относятся к текущему проекту.

Другими словами, нужно, чтобы была общая страница с перечнем проектов, и для каждого проекта была своя титульная страница, взятая из файла readme.md соответствующего src-каталога, а перечень классов данного проекта была на вкладке «Классы».

Как нужно расписать Doxyfile, чтобы получить такую организацию документации?

Сейчас у меня опции прописаны так:
INPUT = . \
 ../main/src \
 ../idk/src \
 ../device_module/device1/src \
 ../device_module/device50/src \
 ../control_panel/src \
 ../logging/src

SEPARATE_MEMBER_PAGES=YES

С такими опциями я смог добиться того, что документация генерируется в виде начальной общей страницы, взятой из файла /main/src/readme.md, в котором прописана команда @mainpage. Есть вкладка «Описания», в которую попадают md-файлы из подкаталогов, так как в них прописана команда @page.

Но если открыть вкладку «Классы», то там будут вперемешку перечислены все классы без разбивки на проекты. Вот это и нужно исправить.

★★★★★

Я вижу только один вариант. Для каждого проекта сгенерировать отдельную документацию и отдельно сделать документацию, «объединяющую» проекты. Ну, буквально, одна страница @mainpage, в котором будет что-то типа:

@link project1/doc/index.html Документация по первому проекту @endlink @link project2/doc/index.html Документация по второму проекту @endlink

Ну и так далее

anonymous
()
Ответ на: комментарий от anonymous

Да, пользуйтесь предпросмотром перед публикацией )))

Я вижу только один вариант. Для каждого проекта сгенерировать отдельную документацию и отдельно сделать документацию, «объединяющую» проекты. Ну, буквально, одна страница \mainpage, в котором будет что-то типа:

\link project1/doc/index.html Документация по первому проекту \endlink

\link project2/doc/index.html Документация по второму проекту \endlink

Ну и так далее

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