このタグでは、設定ファイルのすべての文字に使うエンコードを指定します。デフォルトはUTF-8で、このタグが最初に指定される前のすべてのテキストもUTF-8です。 Doxygenはlibiconv(libcにビルトインされているiconv)を使って変換しています。 エンコードの種類については、http://www.gnu.org/software/libiconvを参照してください。
PROJECT_NAME
PROJECT_NAME
タグは、一単語 (または、ダブルクォートで囲まれた複数単語)からなり、ドキュメントを生成しようとしているプロジェクトの名前となります。 この名前は、生成されたほとんどのページのタイトルとして使われます。 また、少数ですが、別の場所でも使われます。
PROJECT_NUMBER
PROJECT_NUMBER
タグは、プロジェクト番号やリビジョン番号を入れるのに使えます。生成されたドキュメントを保管したり、バージョン管理システムを使うような場合に役立つでしょう。
OUTPUT_DIRECTORY
OUTPUT_DIRECTORY
タグは生成されたドキュメントが置かれるベースパス(相対パスあるいは絶対パス)を指定するために使います。 相対パスを指定した場合は、doxygen を実行した場所からの相対パスとなります。 空白のままにした場合は、カレントディレクトリが使用されます。
CREATE_SUBDIRS
CREATE_SUBDIRS
タグが YES であれば、4096 サブディレクトリ (2段階で) を それぞれの出力形式のディレクトリ下に作成し、そこに生成したファイルを分配します。 このオプションは、doxygenに大量のソースファイルを与えたい場合に有用です。生成される全ファイルを同じディレクトリに排出するとファイルシステムのパフォーマンスに問題を起こす恐れがあります。
OUTPUT_LANGUAGE
OUTPUT_LANGUAGE
タグは、doxygen によって生成されるあらゆるドキュメントの記述言語を指定します。Doxygen は、この情報を使って、すべての既定の文言を適切な言語で生成します。 デフォルトの言語は、English (英語) です。他にサポートされている言語は 次のとおり: Afrikaans (アフリカーンス語)、Arabic (アラビア語)、Brazilian (ブラジル・ポルトガル語)、Catalan (カタロニア語)、Chinese (中国語)、Croatian (クロアチア語)、Czech (チェコ語)、Danish (デンマーク語)、Dutch (オランダ語)、Finnish (フィン語)、French (フランス語)、German (ドイツ語)、Greek (ギリシャ語)、Hungarian (ハンガリー語)、Italian (イタリア語)、Japanese (日本語)、Korean (韓国語)、Lithuanian (リトアニア語)、Norwegian (ノルウェー語)、Persian (ペルシア語)、Polish (ポーランド語)、Portuguese (ポルトガル語)、Romanian (ルーマニア語)、Russian (ロシア語), Serbian (セルビア語)、Slovak (スロヴァキア語)、Slovene (スロヴェニア語)、Spanish (スペイン語)、Swedish (スウェーデン語)、Ukrainian (ウクライナ語)。
USE_WINDOWS_ENCODING
このタグを使って、生成される出力に使うエンコードを指定できます。 エンコードは、選んだ言語だけで決まる場合もあれば、出力が Windows ユーザ向けなのかそうでないのかによっても決まります。 その違いがある場合に USE_WINDOWS_ENCODING タグを YES にすれば、Windows エンコードが (Windows バイナリバージョンではデフォルトです)、NO であれば、Unix 形式のエンコードが行われます(Windows 以外のプラットフォームではデフォルトです)。
BRIEF_MEMBER_DESC
BRIEF_MEMBER_DESC
タグが YES
(デフォルト)であれば、ファイルやクラスのドキュメントの中で、リストしたメンバーの後に要約説明を置きます (JavaDoc 類似)。 NO
に設定すると、この機能は無効になります。
REPEAT_BRIEF
REPEAT_BRIEF
タグが YES (デフォルト) であれば、メンバーや関数についての要約説明を、詳細説明の前に置きます。
- メモ:
HIDE_UNDOC_MEMBERS
と BRIEF_MEMBER_DESC
の両方が NO
に設定された場合は、要約説明は完全に抑制されます。
ABBREVIATE_BRIEF
このタグは、いろいろなリストでテキストを整形するために使う、ある程度識別力のある、要約説明略語化機能です。 指定したリストの各文字列を要約説明中の主要テキストとして認識すると、テキストから除去し、リスト全体を処理した後注釈付きテキストとして扱います。 主要テキストとして認識できないときは、要約説明は原文のまま扱います。 このタグが空白の場合は、次の値を使用します("\$name"は自動的に実体名に置き換わる)。 "The $name class" "The $name widget" "The $name file" "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
ALWAYS_DETAILED_SEC
ALWAYS_DETAILED_SEC
タグ と REPEAT_BRIEF
タグの両方が YES
であれば、要約説明しかなくても詳細説明セクションを生成します。
INLINE_INHERITED_MEMB
INLINE_INHERITED_MEMB
タグが YES であれば、クラスのドキュメントにおいて、 そのクラスの継承メンバー全部を、正規のクラスメンバーのように見せます。 基底クラスのコンストラクタ、デストラクタ、代入演算子は表示されません。
FULL_PATH_NAMES
FULL_PATH_NAMES
タグが YES
であれば、ファイルリストやヘッダーファイルにおいて、ファイル名の前にフルパスを付加します。 NO
に設定すると、ファイル名を一意にするに充分なだけの最も短いパスが付加されます。
STRIP_FROM_PATH
FULL_PATH_NAMES
タグが YES
であれば、STRIP_FROM_PATH
タグを定義することによって、フルパスの一部を除去することができます。除去するのは、パスの先頭部分が定義された文字列の一つにマッチした場合だけです。 ファイルリストで相対パスを示すのに用いることもできます。 空白にすると、起動ディレクトリを除去します。
STRIP_FROM_INC_PATH
ドキュメントのリーダがクラスを利用する際にインクルードするヘッダファイルのパスから、一部を除去するために使います。 空白であれば、クラス定義を含むヘッダファイルの名前だけが使われます。 指定する場合は、通常 -I フラグでコンパイラに渡すインクルードパスを指定してください。
CASE_SENSE_NAMES
CASE_SENSE_NAMES
タグが NO であれば、ファイル名を小文字だけで生成します。 YES であれば、大文字でも生成します。 名前が同じで大文字小文字の違いしかないクラスやファイルがあったり、ファイル名に大文字小文字の区別があるファイルシステムの場合に、有用です。 Windowsユーザは通常 NO に設定してください。
SHORT_NAMES
SHORT_NAMES
タグが YES
であれば、ファイル名をかなり短くします。そのかわり読みにくくなります。 これは、DOS、Mac、CD-ROM といった、長い名前をサポートしていないファイルシステムを使用する場合に有用です。
JAVADOC_AUTOBRIEF
JAVADOC_AUTOBRIEF
タグが YES
であれば、JavaDoc スタイルのコメントの先頭行 (最初の . まで) を要約説明と解釈します。 NO
(デフォルト) に設定すると、 JavaDoc スタイルは、Qt スタイルのコメントと同じように扱います(要約説明として扱うには @brief コマンドを指定する必要があります)。
QT_AUTOBRIEF
QT_AUTOBRIEF
タグを YES
であれば、Qt スタイルコメントの先頭行 (最初の . まで) を要約説明と解釈します。 NO
(デフォルト) に設定すると、Qt スタイルは、通常のQt スタイルコメントと同じように扱います(要約説明として扱うには \brief コマンドを指定する必要があります)。
BUILTIN_STL_SUPPORT
STLクラス (std::string, std::vector など) を使っていても、STLソース (そのタグファイル) を入力としてインクルードしたくない場合は、このタグを YES にしてください。 するとdoxygenは、STLクラスを引数に含む関数宣言と定義 (たとえば、func(std::string); と func(std::string) {}) をマッチングします。 また、STLクラスを含む継承・コラボレーション図をより完璧で正確にすることもできます。
CPP_CLI_SUPPORT
Microsoftの C++/CLI 言語を使う場合は、解析を有効にするためこのオプションをYESにしてください。
SIP_SUPPORT
sipソースのみでプロジェクトを構成している場合は、SIP_SUPPORTタグをYESにしてください。 すると、通常のC++同様に解析しますが、保護レベルを明示していない限り、すべてのクラスをprivateでなくpublic継承を使っているものと想定します。
IDL_PROPERTY_SUPPORT
MicrosoftのIDLには、属性のget/setメソッドを示すためのpropget/propput属性があります。このオプションを YES
(デフォルト)にすると、説明の中のプロパティでget/setメソッドを入れ替えることができます。ただし、メソッドが単純なタイプをget/setしている場合だけです。そうでない場合や、メソッドを表示したい場合は、このオプションをNOにしてください。
DISTRIBUTE_GROUP_DOC
メンバーのグループ化がドキュメント内で使われており、DISTRIBUTE_GROUP_DOC
タグが YES
であれば、グループ内の最初のメンバーのドキュメント (もしあれば) を、そのグループの他のメンバーに対して再利用します。デフォルトでは、グループ内のすべてのメンバーは、明示的にドキュメント付られている必要があります。
MULTILINE_CPP_IS_BRIEF
MULTILINE_CPP_IS_BRIEF タグを YES にすると、複数行 C++ 特別コメントブロック (//! や /// コメントのブロック) を要約説明として扱います。これは以前のデフォルトの振る舞いでした。新しいデフォルトでは、複数行の C++ コメントブロックを詳細説明として扱います。以前の振る舞いが好みならこのタグを YES にしてください。ただし、rational rose コメントは認識しなくなります。
INHERIT_DOCS
INHERIT_DOCSタグを YES (デフォルト)にすると、ドキュメントがないメンバーの場合、再実装するメンバーからドキュメントを引き継いできます。
SEPARATE_MEMBER_PAGES
SEPARATE_MEMBER_PAGES タグを YES にすると、各メンバーにページを割り当てます。 NOにすると、メンバーのドキュメントは、それを内包するファイル・クラス・名前空間の一部になります。
TAB_SIZE
TAB_SIZE
タグは、タブの幅 (スペースの数) を設定します。 doxygen は、この値を使用して、コード片においてタブをスペースに置換します。
ALIASES
このタグは、ドキュメント内でコマンドとして振る舞うような、いくつかの別名を記述するのに使用されます。別名は、次の形式をしています。
たとえば、次の行を追加すると、
"sideeffect=\par Side Effects:\n"
ドキュメント内で \sideeffect (or @sideeffect) というコマンドが使えるようになります。このコマンドは、結果として、"Side Effects:" という見出しを持つユーザ定義のパラグラフを生成します。 別名の値のところに \n を置くと改行が挿入されます。
OPTIMIZE_OUTPUT_FOR_C
プロジェクトが C のソースだけからなっている場合は、OPTIMIZE_OUTPUT_FOR_C
タグを YES
に設定してください。 doxygen は、より C に適合した出力を生成します。 たとえば、使用される名前のいくつかが異なっていたり、全メンバーのリストが省略される、など。
OPTIMIZE_OUTPUT_JAVA
JavaやPythonのソースだけでプロジェクトを構成している場合は、OPTIMIZE_OUTPUT_JAVA タグを YES にしてください。すると、その言語により適合した出力を生成します。たとえば、名前空間はパッケージとして提示され、修飾スコープは別の形で提示されるなど。
OPTIMIZE_FOR_FORTRAN
Fortranソースで構成されるプロジェクトの場合は、OPTIMIZE_FOR_FORTRAN
タグを YES
にしてください。Fortranに適合した出力をします。
OPTIMIZE_OUTPUT_VHDL
VHDLソースで構成されるプロジェクトの場合は、OPTIMIZE_OUTPUT_VHDL
タグを YES
にしてください。DoxygenはVHDLに適合した出力をします。
EXTENSION_MAPPING
Doxygenでは、解析するファイルの拡張子にしたがって、パーサーを選択します。 このタグを使って、与えられた拡張子についてどのパーサを使うかを指定できます。
Doxygenには組み込みの仕様がありますが、このタグを使えば上書きまたは拡張できます。 指定方式は、ext=languageで、ext にはファイル拡張子を、languageにはパーサを指定します。languageは次のうちどれかです。IDL, Java, Javascript, C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++。 たとえば .incファイル(デフォルトはPHP)をFortranファイルとして扱い、.fファイル(デフォルトはFortran)をCファイルとして扱うには、inc=Fortran f=C とします。
SUBGROUPING
SUBGROUPING タグを YES (デフォルト) にすると、同じタイプのクラスメンバーグループ (public 関数群など)が、そのタイプのサブグループ(Public関数セクションなど)として扱われます。サブグループ化を避けるには NO にしてください。 これは、クラスごとに\nosubgrouping コマンドを使ってもできます。
TYPEDEF_HIDES_STRUCT
TYPEDEF_HIDES_STRUCT
を YES にすると、struct, union, enum の typedef は、typedef の名をつけて、struct, union, enum としてドキュメント出力されます。 typedef struct TypeS {} TypeT
という構造の場合は、TypeTという名の
struct として出力されます。 TYPEDEF_HIDES_STRUCT
を NO にすると、typedef は、ファイル、名前空間、またはクラスのメンバーとして出力されます。struct は TypeS
という名で出力されます。 C言語で、コーディング規約によって複合型はすべて typedef で定義され、typedef だけが参照され、タグ名は参照されない場合に、有用です。
SYMBOL_CACHE_SIZE
SYMBOL_CACHE_SIZEを指定したサイズは、内部キャッシュのサイズで、これによりどのシンボルを残し、どのシンボルをディスクにフラッシュするかが決まります。
キャッシュが満杯の場合は、使用回数の少ないシンボルからディスクに書き出されます。 中小規模のプロジェクト(入力ファイルが1000未満)の場合、デフォルトの値で十分でしょう。大規模プロジェクトの場合、キャッシュサイズが小さすぎると、ディスクとの間のシンボルスワッピングに追われてしまい、パフォーマンスがかなり悪くなる可能性があります。 システムの物理メモリサイズが充分であれば、キャッシュサイズを増やせば、メモリにシンボルをより残せるのでパフォーマンスが改善するでしょう。値は対数スケールで働くので、1増やせばメモリ使用がほぼ倍増します。キャッシュサイズは次の式で与えられます。 シンボルのキャッシュサイズにしたがって、有効な範囲は、0から9で、デフォルトは0です。