Как сгенерировать файлы .dox?

Question

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

call "%doxygen%" %%f.dox > %%f.log 2> %%f.err 

мне было интересно, как генерировать .dox файлы? используя DoxyWizard, например, возможно? есть ли другой способ?

В качестве начального этапа я могу использовать команду doxygen -g configFile для создания файла конфигурации шаблона для редактирования.

Answer 1

Расширение .dox обычно используется для специальных страниц в doxygen.

Вы можете использовать обычные команды Doxygen найти здесь:

http://www.stack.nl/~dimitri/doxygen/manual/commands.html

Обычно, вы начинаете специальную страницу с помощью @Page или @mainpage.

Шаблон, который вы создали, это конфигурация для doxygen, там вы определяете, каким образом/какой вывод создается, какие файлы включать и т. Д.

документация для конфигурации здесь:

http://www.stack.nl/~dimitri/doxygen/manual/config.html

Таким образом, первый довольствуется (страницы, как комментирование кода), вторая конфигурация набора инструментов.

Можно явно настроить Doxygen, чтобы включить свой .dox файл через

INCLUDE += myfile.dox

в вашем .doxycfg.

Также см эти вопросы на SO:

• How to include custom files in Doxygen
• Can Doxygen process pages other than MainPage.dox
• Issue with doxygen .dox files
• How to make an introduction page with Doxygen