Как добавить пользовательские файлы в Doxygen

Я хотел бы добавить пользовательские (непроектные) файлы для создания дополнительных страниц с Doxygen.

Я (на самом деле) не знаю, как эти файлы должны быть названы и как их содержимое должно быть отформатировано.

Ответ 1

Я много искал, прежде чем нашел ответ, поэтому подумал, что было бы неплохо поделиться!

В соответствии с этой Doxygen gotchas в статье я наконец обнаружил, что: вам нужно добавить файл с расширением dox, Его содержимое должно содержать блоки комментариев в стиле C:

/*!
  \page My test page
  contents
  ...
  more contents
*/

Убедитесь, что ваши пользовательские файлы помещены в каталог, который включен в параметр INPUT или в текущем каталоге, если INPUT оставлен пустым, поэтому эти файлы можно найти.

Ответ 2

Просто для полноты: есть 3 возможных расширения, которые doxygen рассматривает как дополнительные файлы документации:.dox,.txt и .doc.

Файлы, которые такие расширения скрыты от индекса файла. Внутри файла вам нужно поместить один или несколько блоков комментариев в стиле C/С++.

Ответ 3

Для еще большей полноты, начиная с версии Doxygen версии 1.8 (я полагаю), теперь она поддерживает дополнительные текстовые файлы, которые очень похожи на markdown синтаксис. Вам больше не нужно использовать блоки комментариев стиля C/С++. Вместо этого просто напишите почти нормальный текст и убедитесь, что текстовый файл находится в пути INPUT, и что ваше доксигенное сканирование фактически ищет файлы с расширением .markdown(или любым другим расширением, которое вы хотите использовать, например .md).

Ответ 4

Для наглядности:

В файле конфигурации .dox добавьте файл в директиву INPUT с чем-то например:

INPUT = ../src \
        ../include \
        ../docs/my-extra-file.txt

Если файл имел соответствующее расширение, скажем, как .h или .c, тогда Doxygen найдет файл без добавления директивы INPUT. Внутри файла используйте обычные теги Doxygen, как в источнике, то есть внутри блоков комментариев, например:

/*! \mainpage MyProject - A Brief Description.
\image html Mylogo.png
\section my-intro MyProject Introduction
\htmlinclude about-MyProject.html
*/

Можно также использовать один из тегов include, таких как "\ htmlinclude" в приведенном выше примере, где-нибудь в коде.

Ответ 5

Просто укажите свои пользовательские файлы в макросе INPUT в вашем файле doxyfile. Вы можете выбрать любое имя, которое вам подходит. Формат - это текст с тегами Doxygen.