Doxygen распознает и анализирует любой файл с расширением * .dox и включит его в итоговую документацию.То, что эти файлы произведут, продиктовано комментариями doxygen, расположенными в файле.Например, если вы хотите изменить главную страницу, вам понадобится комментарий, например:
/**
* @mainpage
* Documentation you want to occur on the main page.
*/
Вы также можете создать документацию, которая должна появляться на других страницах, используя эту технику:
/**
* @page another_page Another Page
* Documentation that will occur on another page.
*/
Предполагая вывод HTML, эта форма создаст файл с именем another_page.html
на том же уровне, что и index.html
.Заголовок будет Another Page
, и ссылка на контент будет следовать.Также будет создана дополнительная вкладка с именем Related Pages
, которая будет содержать ссылки на все связанные страницы, созданные таким образом.
Подобные блоки могут появляться в любом файле, который анализирует doxygen (включая заголовочные или исходные файлы)и может содержать определения для нескольких страниц (оба приведенных выше комментария могут быть в одном файле).Файл, в котором они находятся, не влияет на создаваемый вывод.