Главная страница в документации Doxygen

Как настроить основную страницу (индексную страницу) для документации по doxygen? Я знаю, что мы должны использовать \mainpage где-то, но я не знаю, где. Предполагается, что Am должен включать в каждый заголовок/исходный файл в моем проекте?

ОТВЕТЫ

Ответ 1

Doxygen будет проверять файлы .dox по умолчанию. Таким образом, вы можете создать файл с именем "mainpage.dox" и разместить там главную страницу:

/**
\mainpage The mainpage documentation

This is a simple example of a mainpage you can create yourself.
Place this inside of a file called `mainpage.dox` and use doxygen.
If you specified `INPUT` or `FILE_PATTERNS` in your Doxyfile please
add `.dox` to your file patterns or `mainpage.dox` to your INPUT files.
*/

В проекте должен быть только один \mainpage (см. Doxygen: несколько \mainpage блоков в проекте С++).