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

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

# Main Page # {#mainpage}

, ни

# Main Page # {#index}

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

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

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

Я использую Doxygen 1.8.2 (загружено) и 1.8.1.1 (из MacPorts) для этой задачи.

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

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

EDIT: я включил поддержку markdown, и файл появляется на ссылочных страницах.

32
doxygen doxywizard markdown

2 ответов

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

INPUT                  = README.md other_sources
USE_MDFILE_AS_MAINPAGE = README.md

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

91

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

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

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

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

12