2011-09-14 32 views
4

概念的には、restructuredtextの行に沿って、私はさまざまなソースディレクトリにreadmeファイルを配布し、Doxygenを読み込み、生成されたDoxygen出力の一部としてこれらのreadmeテキストファイルを含める必要があります。Doxygen出力に自動的に含まれるreadmeファイルの書き方は?

これはどのように行われますか?あなただけのあなただけのdoxygenの設定ファイルのHTML_EXTRA_FILESフィールドを使用することができますHTML出力を使用している場合

/** 
My big long readme file describing how this library 
was created and how it should be used 
*/ 
namespace foo_readme { } 

答えて

6

README.h:それとも私のような擬似Cファイルを作成することにより、Doxygenのを偽装する必要があります。

プレーンテキストのREADMEファイルがある場合は、プログラムディレクトリに手動で追加するだけです。

.hファイルを\mainpageというタグでスプーフィングして、doxygen出力のインデックス(メイン)ページに入力することもできます。

関連する問題