web-dev-qa-db-ja.com

DoxygenのメインページとしてREADME.mdファイルを使用します

Doxygenのドキュメントには、PHP Markdownマークダウンファイルで追加のタイトルラベルを使用できますが、

# Main Page # {#mainpage}

また

# Main Page # {#index}

動作しますが、ラベルもプレーンテキストとして出力に存在しません。これが最初の行です。

また、上記のラベルもファイル名も使用せずにそのページを参照することはできません。

また、main.doxファイルには\mainpage特別なコマンドですが、上記のすべての前にスラッシュを1つ削除してみました(2つだけにするため)。

タスクにはDoxygen 1.8.2(ダウンロード)と1.8.1.1(MacPortsから)を使用しています。

どうすればこれを達成できますか?

また、特定の言語の一部としてマークダウンファイルをマークするにはどうすればよいですか?

編集:マークダウンサポートを有効にし、参照ページにファイルが表示されます。

46
Adam L. S.

Doxygen(1.8.3)の次のリリースでは、新しい構成オプションUSE_MDFILE_AS_MAINPAGEこれは、メインページとして使用されるマークダウンページを指定するために使用できます。次に、doxygenを次のように構成できます。

INPUT                  = README.md other_sources
USE_MDFILE_AS_MAINPAGE = README.md

また、ページの見出しに関係なく機能します。

113
doxygen

代わりに次を試して、タイトルをレベル1ヘッダーとしてマークしてください。

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

Doxygen 1.8.2では、これによりページがindex.html私のためのページ。

Doxygen文書は、単一の#はレベル1ヘッダーを宣言しますが、私にとっても機能していないようです。

14
Masked Man