Может ли Doxygen обрабатывать страницы, отличные от MainPage.dox - PullRequest
5 голосов
/ 22 августа 2011

Если вы поместите файл MainPage.dox в путь поиска Doxygen, он добавит его к выводу в Doxygen / html над исходной документацией. Но вы можете иметь несколько файлов, таких как MainPage.dox? Или вы ограничены одним?

Ответы [ 2 ]

6 голосов
/ 29 декабря 2011

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 (включая заголовочные или исходные файлы)и может содержать определения для нескольких страниц (оба приведенных выше комментария могут быть в одном файле).Файл, в котором они находятся, не влияет на создаваемый вывод.

2 голосов

Начиная с 1.8.4, .md страницы уценки также могут быть включены как отдельные страницы без необходимости для .dox C ++ подобных комментариев /** */, если они должны рассматриваться doxygen в соответствии с вашими INPUT иFILE_PATTERNS config.

Разница между использованием .md и .dox состоит в том, что файлы .md создают связанную страницу с тем же именем, что и базовое имя, без расширения файла .md, тогда как .dox создает только страницы с именами, заданными командами \page.

Все еще можно использовать команды \page из файлов .md.

Например, если файл md_page.mdсодержит:

Inside md_page.

\page md_page2 Md Page 2

Inside md_page2

, при этом будут созданы 2 страницы в разделе «Связанные страницы», озаглавленные:

  • md_page
  • Md Page 2
...