Используйте файл README.md как главную страницу в Doxygen

Документация состояний Doxygen, что я могу использовать маркировку заголовка PHP Markdown Extra в файле уценки, но ни

# Main Page # {#mainpage}

ни

# Main Page # {#index}

работает, но метка отсутствует в выводе как обычный текст. Это первая строка BTW.

Также я не могу ссылаться на эту страницу ни с указанными выше метками, ни с именем файла.

У меня также есть файл main.dox, содержащий специальную команду \mainpage, но я также пробовал все вышеперечисленное с удалением одной косой черты перед ними (чтобы сделать ее только двумя).

Я использую Doxygen 1.8.2 (скачано) и 1.8.1.1 (из MacPorts) для выполнения задачи.

Как я могу это достичь?

Также, как я могу пометить файл разметки как часть определенного языка?

РЕДАКТИРОВАТЬ: Я включил поддержку разметки, и файл появляется на ссылочных страницах.

Ответы

Ответ 1

В следующей версии doxygen (1.8.3) я планирую ввести новый параметр конфигурации USE_MDFILE_AS_MAINPAGE, который можно использовать для указания страницы разметки, которая будет использоваться в качестве главной страницы. Затем вы можете настроить doxygen следующим образом:

INPUT                  = README.md other_sources
USE_MDFILE_AS_MAINPAGE = README.md

и он будет работать независимо от заголовков страниц.

Ответ 2

Попробуйте вместо этого отметить заголовок как заголовок уровня 1:

Main Page {#mainpage}
=========

С doxygen 1.8.2 это делает страницу страницей index.html для меня.

В документе doxygen указано, что запуск строки с одним # объявляет заголовок уровня 1, но, похоже, он тоже не работает для меня.