設定ファイルは、Makefileに似た構造を持つ自由形式のASCIIテキストファイルであり、デフォルトの名前はDoxyfileです。doxygenによってパースされます。ファイルには、書式設定のためにタブと改行を含めることができます。ファイル内のステートメントは大文字と小文字を区別します。
設定ファイルは、基本的に代入ステートメントのリストで構成されます。各ステートメントは、大文字で記述されたTAG_NAMEの後に、等号 (=) と1つ以上の値が続きます。同じタグが複数回割り当てられた場合、最後の代入が以前の代入を上書きします。リストを引数として取るタグの場合、リストに新しい値を追加するには、=の代わりに+=演算子を使用できます。値は空白を含まないシーケンスです。値に1つ以上の空白が含まれる場合は、引用符 ("...") で囲む必要があります。複数の行は、行の最後の非空白文字としてバックスラッシュ (\) を挿入することで連結できます。
コメントはハッシュ文字 (#) で始まり、行の終わりで終了します。コメントはファイル内のどこにでも配置できます (引用符内を除く)。2つのハッシュ文字 (##) で始まるコメントは、TAG_NAMEの前に配置された場合、または設定ファイルの最初または最後に配置された場合、設定ファイルを更新する際に保持されます。
環境変数は、パターン $(ENV_VARIABLE_NAME) を使用して展開できます。小さな例
DOT_PATH = $(YOUR_DOT_PATH)
また、次のように@INCLUDEタグを使用して、別の設定ファイルから設定ファイルの一部を含めることもできます。
@INCLUDE = config_file_name
インクルードファイルは現在の作業ディレクトリで検索されます。現在の作業ディレクトリを検索する前に検索するディレクトリのリストを指定することもできます。これは、@INCLUDEタグの前にこれらのパスを含む@INCLUDE_PATHタグを配置することで行います。例:
@INCLUDE_PATH = my_config_dir
設定オプションはいくつかのカテゴリに分類できます。以下は、認識されるタグのアルファベット順のインデックスと、カテゴリ別にグループ化されたタグの説明です。
DOXYFILE_ENCODING このタグは、以降の設定ファイル内のすべての文字に使用されるエンコーディングを指定します。デフォルトはUTF-8で、このタグが最初に現れるまでのすべてのテキストにも使用されます。Doxygenは、トランスコーディングにlibiconv (またはlibcに組み込まれているiconv) を使用します。利用可能なエンコーディングのリストについては、https://www.gnu.org/software/libiconv/ を参照してください。
デフォルト値は: UTF-8 です。
PROJECT_NAME PROJECT_NAMEタグは、ドキュメントが生成されるプロジェクトを識別するための単一の単語（Doxywizardを使用している場合を除き、二重引用符で囲まれた単語のシーケンス）です。この名前は、生成されたほとんどのページのタイトルや他のいくつかの場所で使用されます。
デフォルト値は: My Project です。
PROJECT_NUMBER PROJECT_NUMBERタグは、プロジェクトまたはリビジョン番号を入力するために使用できます。これは、生成されたドキュメントのアーカイブや、バージョン管理システムが使用されている場合に便利です。
PROJECT_BRIEF PROJECT_BRIEFタグを使用すると、各ページの上部に表示され、プロジェクトの目的を閲覧者に素早く伝えるためのオプションの1行の説明を提供できます。説明は短くしてください。
PROJECT_LOGO PROJECT_LOGOタグを使用すると、ドキュメントに含まれるロゴまたはアイコンを指定できます。ロゴの最大高さは55ピクセルを超えてはならず、最大幅は200ピクセルを超えてはなりません。Doxygenはロゴを出力ディレクトリにコピーします。
PROJECT_ICON PROJECT_ICONタグを使用すると、HTMLドキュメントが表示されたときにタブに含まれるアイコンを指定できます。Doxygenはアイコンを出力ディレクトリにコピーします。
OUTPUT_DIRECTORY OUTPUT_DIRECTORYタグは、生成されたドキュメントが書き込まれる（相対または絶対）パスを指定するために使用されます。相対パスが入力された場合、Doxygenが開始された場所からの相対パスになります。空白のままにすると、現在のディレクトリが使用されます。
CREATE_SUBDIRS CREATE_SUBDIRSタグがYESに設定されている場合、Doxygenは各出力形式の出力ディレクトリの下に最大4096個のサブディレクトリ（2レベル）を作成し、生成されたファイルをこれらのディレクトリに分散させます。このオプションを有効にすると、Doxygenに大量のソースファイルを供給する際に、すべての生成ファイルを同じディレクトリに置くとファイルシステムにパフォーマンスの問題が発生する可能性がある場合に役立ちます。サブディレクトリの数を制御するにはCREATE_SUBDIRS_LEVELを調整してください。
デフォルト値は: NO です。
CREATE_SUBDIRS_LEVEL CREATE_SUBDIRSタグがYESに設定されている場合に作成されるサブディレクトリの数を制御します。レベル0は16個のディレクトリを表し、レベルが1増えるごとにディレクトリの数が倍になり、デフォルトかつ最大値であるレベル8では4096個のディレクトリになります。サブディレクトリは2つのレベルで構成され、最初のレベルには常に16個の固定数のディレクトリがあります。
最小値: 0、最大値: 8、デフォルト値: 8。
このタグを使用するには、タグCREATE_SUBDIRSがYESに設定されている必要があります。
ALLOW_UNICODE_NAMES ALLOW_UNICODE_NAMESタグがYESに設定されている場合、Doxygenは生成されるファイル名に非ASCII文字の使用を許可します。NOに設定されている場合、非ASCII文字はエスケープされ、例えばUnicode U+3044には_xE3_x81_x84が使用されます。
デフォルト値は: NO です。
OUTPUT_LANGUAGE OUTPUT_LANGUAGEタグは、Doxygenによって生成されるすべてのドキュメントが記述される言語を指定するために使用されます。Doxygenはこの情報を使用して、すべての定数出力を適切な言語で生成します。
指定可能な値は: アフリカーンス語、アラビア語、アルメニア語、ブラジル語、ブルガリア語、カタルーニャ語、中国語、中国語 (繁体字)、クロアチア語、チェコ語、デンマーク語、オランダ語、英語 (米国)、エスペラント語、ペルシャ語 (ファルシ語)、フィンランド語、フランス語、ドイツ語、ギリシャ語、ヒンディー語、ハンガリー語、インドネシア語、イタリア語、日本語、日本語-en (英語メッセージ付き日本語)、韓国語、韓国語-en (英語メッセージ付き韓国語)、ラトビア語、リトアニア語、マケドニア語、ノルウェー語、ペルシャ語 (ファルシ語)、ポーランド語、ポルトガル語、ルーマニア語、ロシア語、セルビア語、セルビア語 (キリル文字)、スロバキア語、スロベニア語、スペイン語、スウェーデン語、トルコ語、ウクライナ語、ベトナム語です。
デフォルト値は: English です。
BRIEF_MEMBER_DESC BRIEF_MEMBER_DESCタグがYESに設定されている場合、Doxygenはファイルおよびクラスドキュメントにリストされているメンバーの後に簡単なメンバー説明を含めます（Javadocに類似）。これを無効にするにはNOに設定します。
デフォルト値は: YES です。
REPEAT_BRIEF REPEAT_BRIEFタグがYESに設定されている場合、Doxygenはメンバーまたは関数の簡単な説明を詳細な説明の前に付加します。
注: HIDE_UNDOC_MEMBERSとBRIEF_MEMBER_DESCの両方がNOに設定されている場合、簡単な説明は完全に抑制されます。
デフォルト値は: YES です。
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に設定されている場合、Doxygenは簡単な説明しかなくても詳細セクションを生成します。
デフォルト値は: NO です。
INLINE_INHERITED_MEMB INLINE_INHERITED_MEMBタグがYESに設定されている場合、Doxygenはクラスのドキュメントにおいて、そのクラスの継承されたすべてのメンバーを、それらのメンバーが通常のクラスメンバーであるかのように表示します。基底クラスのコンストラクタ、デストラクタ、および代入演算子は表示されません。
デフォルト値は: NO です。
FULL_PATH_NAMES FULL_PATH_NAMESタグがYESに設定されている場合、Doxygenはファイルリストおよびヘッダーファイル内のファイル名の前にフルパスを付加します。NOに設定されている場合、ファイル名を一意にする最短パスが使用されます。
デフォルト値は: YES です。
STRIP_FROM_PATH STRIP_FROM_PATHタグは、パスのユーザー定義部分を削除するために使用できます。削除は、指定された文字列のいずれかがパスの左側と一致する場合にのみ行われます。このタグは、ファイルリストに相対パスを表示するために使用できます。空白のままにすると、Doxygenが実行されるディレクトリが削除対象のパスとして使用されます。
ここで絶対パスを指定できるだけでなく、Doxygenが開始されたディレクトリからの相対パスも指定できることに注意してください。
このタグを使用するには、タグFULL_PATH_NAMESがYESに設定されている必要があります。
STRIP_FROM_INC_PATH STRIP_FROM_INC_PATHタグは、クラスのドキュメントに記載されているパスのユーザー定義部分を削除するために使用できます。これは、クラスを使用するためにどのヘッダーファイルを含めるべきかを読者に伝えます。空白のままにした場合、クラス定義を含むヘッダーファイルの名前のみが使用されます。それ以外の場合、通常-Iフラグを使用してコンパイラに渡されるインクルードパスのリストを指定する必要があります。
SHORT_NAMES SHORT_NAMESタグがYESに設定されている場合、Doxygenははるかに短い（ただし読みにくい）ファイル名を生成します。これは、DOS、Mac、CD-ROMなどのようにファイルシステムが長い名前をサポートしていない場合に役立ちます。
デフォルト値は: NO です。
JAVADOC_AUTOBRIEF JAVADOC_AUTOBRIEFタグがYESに設定されている場合、DoxygenはJavadocスタイルのコメントの最初の行（最初のピリオド、疑問符、または感嘆符まで）を簡単な説明として解釈します。NOに設定されている場合、Javadocスタイルは通常のQtスタイルコメントと同様に動作します（したがって、簡単な説明のために明示的な@briefコマンドが必要です）。
デフォルト値は: NO です。
JAVADOC_BANNER JAVADOC_BANNERタグがYESに設定されている場合、Doxygenは次のような行を解釈します。
/***************
Javadocスタイルのコメント「バナー」の始まりとして。NOに設定されている場合、Javadocスタイルは通常のコメントと同様に動作し、Doxygenによって解釈されません。
デフォルト値は: NO です。
QT_AUTOBRIEF QT_AUTOBRIEFタグがYESに設定されている場合、DoxygenはQtスタイルのコメントの最初の行（最初のピリオド、疑問符、または感嘆符まで）を簡単な説明として解釈します。NOに設定されている場合、Qtスタイルは通常のQtスタイルコメントと同様に動作します（したがって、簡単な説明のために明示的な\briefコマンドが必要です）。
デフォルト値は: NO です。
MULTILINE_CPP_IS_BRIEF MULTILINE_CPP_IS_BRIEFタグをYESに設定すると、Doxygenは複数行のC++特殊コメントブロック（つまり、//!または///コメントのブロック）を簡単な説明として扱います。これは以前のデフォルトの動作でした。新しいデフォルトでは、複数行のC++コメントブロックを詳細な説明として扱います。古い動作を好む場合は、このタグをYESに設定してください。
このタグをYESに設定すると、Rational Roseコメントが認識されなくなることにも注意してください。
デフォルト値は: NO です。
PYTHON_DOCSTRING デフォルトでは、Pythonのdocstringsは整形済みテキストとして表示され、Doxygenの特殊コマンドは使用できません。PYTHON_DOCSTRINGをNOに設定すると、Doxygenの特殊コマンドが使用でき、docstringドキュメントブロックの内容がDoxygenドキュメントとして表示されます。
デフォルト値は: YES です。
INHERIT_DOCS INHERIT_DOCSタグがYESに設定されている場合、ドキュメント化されていないメンバーは、それが再実装するドキュメント化されたメンバーからドキュメントを継承します。
デフォルト値は: YES です。
SEPARATE_MEMBER_PAGES SEPARATE_MEMBER_PAGESタグがYESに設定されている場合、Doxygenは各メンバーに新しいページを生成します。NOに設定されている場合、メンバーのドキュメントは、それを含むファイル/クラス/名前空間の一部になります。
デフォルト値は: NO です。
TAB_SIZE TAB_SIZEタグは、タブ内のスペース数を設定するために使用できます。Doxygenはこの値を使用して、コードフラグメント内のタブをスペースに置き換えます。
最小値: 1、最大値: 16、デフォルト値: 4。
ALIASES このタグは、ドキュメント内でコマンドとして機能する多数のエイリアスを指定するために使用できます。エイリアスの形式は次のとおりです。
name=value
例えば、追加することで
"sideeffect=@par Side Effects:^^"
ドキュメントに\sideeffect（または@sideeffect）コマンドを記述できるようになり、「副作用:」という見出しのユーザー定義段落が生成されます。エイリアスの値部分に改行（結果の出力で）を挿入するために\nを入れることはできません。元のファイルに物理的な改行があったかのように改行を挿入するには、エイリアスの値部分に^^を入れることができます。エイリアスの値部分でリテラルの{または}または,が必要な場合は、バックスラッシュ（\）でエスケープする必要があります。これは、コマンド\{および\}との競合につながる可能性があるため、@{および@}のバージョンを使用するか、二重エスケープ（\\{および\\}）を使用することをお勧めします。
OPTIMIZE_OUTPUT_FOR_C プロジェクトがCソースのみで構成されている場合、OPTIMIZE_OUTPUT_FOR_CタグをYESに設定します。DoxygenはCに合わせた出力を生成します。例えば、使用される名前の一部が異なります。すべてのメンバーのリストは省略されます。
デフォルト値は: NO です。
OPTIMIZE_OUTPUT_JAVA プロジェクトがJavaまたはPythonソースのみで構成されている場合、OPTIMIZE_OUTPUT_JAVAタグをYESに設定します。Doxygenはその言語に合わせた出力を生成します。例えば、名前空間はパッケージとして表示され、修飾スコープは異なるように見えます。
デフォルト値は: NO です。
OPTIMIZE_FOR_FORTRAN プロジェクトがFortranソースで構成されている場合、OPTIMIZE_FOR_FORTRANタグをYESに設定します。DoxygenはFortranに合わせた出力を生成します。
デフォルト値は: NO です。
OPTIMIZE_OUTPUT_VHDL プロジェクトがVHDLソースで構成されている場合、OPTIMIZE_OUTPUT_VHDLタグをYESに設定します。DoxygenはVHDLに合わせた出力を生成します。
デフォルト値は: NO です。
OPTIMIZE_OUTPUT_SLICE プロジェクトがSliceソースのみで構成されている場合、OPTIMIZE_OUTPUT_SLICEタグをYESに設定します。Doxygenはその言語に合わせた出力を生成します。例えば、名前空間はモジュールとして表示され、型はより多くのグループに分けられます。
デフォルト値は: NO です。
EXTENSION_MAPPING Doxygenは、パースするファイルの拡張子に応じて使用するパーサーを選択します。このタグを使用して、特定の拡張子にどのパーサーを使用するかを割り当てることができます。Doxygenには組み込みのマッピングがありますが、このタグを使用してそれをオーバーライドまたは拡張できます。形式はext=languageで、extはファイル拡張子、languageはDoxygenがサポートするパーサーの1つです: IDL、Java、JavaScript、Csharp (C#)、C、C++、Lex、D、PHP、md (Markdown)、Objective-C、Python、Slice、VHDL、Fortran (固定形式Fortran: FortranFixed、自由形式Fortran: FortranFree、不明な形式Fortran: Fortran。後者の場合、パーサーはコードが固定形式か自由形式かを推測しようとします。これはFortranタイプのファイルのデフォルトです)。
例えば、Doxygenに.incファイルをFortranファイルとして（デフォルトはPHP）、.fファイルをCとして（デフォルトはFortran）扱わせるには、次のように使用します: inc=Fortran f=C。
注: 拡張子のないファイルには、プレースホルダとしてno_extensionを使用できます。
カスタム拡張子の場合、FILE_PATTERNSも設定する必要があることに注意してください。そうしないと、Doxygenによってファイルが読み込まれません。no_extensionを指定する場合は、*をFILE_PATTERNSに追加する必要があります。
デフォルトのファイル拡張子マッピングのリストも参照してください。
MARKDOWN_SUPPORT MARKDOWN_SUPPORTタグが有効になっている場合、DoxygenはすべてのコメントをMarkdown形式に従って前処理し、より読みやすいドキュメントを可能にします。詳細については、https://daringfireball.net/projects/markdown/ を参照してください。Markdown処理の出力はDoxygenによってさらに処理されるため、Doxygen、HTML、XMLコマンドとMarkdown書式設定を混在させることができます。後方互換性の問題がある場合にのみ無効にしてください。
デフォルト値は: YES です。
TOC_INCLUDE_HEADINGS TOC_INCLUDE_HEADINGSタグが非ゼロの値に設定されている場合、そのレベルまでのすべての見出しは、id属性を持っていなくても、自動的に目次に含まれます。
最小値: 0、最大値: 99、デフォルト値: 6。
このタグを使用するには、タグMARKDOWN_SUPPORTがYESに設定されている必要があります。
MARKDOWN_ID_STYLE MARKDOWN_ID_STYLEタグは、Markdownの見出しの識別子を生成するために使用されるアルゴリズムを指定するために使用できます。注: すべての識別子は一意です。
指定可能な値は: DOXYGENは固定文字列'autotoc_md'の後に0から始まる連番を使用し、GITHUBはタイトルを小文字にして空白を'-'に置き換え、句読点を削除したものを使用します。
デフォルト値は: DOXYGEN です。
このタグを使用するには、タグMARKDOWN_SUPPORTがYESに設定されている必要があります。
AUTOLINK_SUPPORT 有効にすると、Doxygenはドキュメント化されたクラスまたは名前空間に対応する単語を、その対応するドキュメントにリンクしようとします。このようなリンクは、単語の前に%記号を付けることで個々のケースで防止でき、またはAUTOLINK_SUPPORTをNOに設定することでグローバルに防止できます。AUTOLINK_IGNORE_WORDSタグにリストされている単語は、自動リンクから除外されます。
デフォルト値は: YES です。
AUTOLINK_IGNORE_WORDS このタグは、ドキュメント内の単語の先頭と一致した場合に、AUTOLINK_SUPPORTによって自動リンク生成が有効になっている場合に、それを抑制する単語のリストを指定します。このリストは、#または\linkまたは\refコマンドを使用して明示的に作成されたリンクには影響しません。
このタグを使用するには、タグAUTOLINK_SUPPORTがYESに設定されている必要があります。
BUILTIN_STL_SUPPORT STLクラス（例: std::string、std::vectorなど）を使用しているが、STLソースを（タグファイルとして）入力に含めたくない場合は、このタグをYESに設定して、引数にSTLクラスを含む関数の宣言と定義をDoxygenが一致できるようにする必要があります（例: func(std::string); 対 func(std::string) {}）。これにより、STLクラスを含む継承図とコラボレーション図もより完全で正確になります。
デフォルト値は: NO です。
CPP_CLI_SUPPORT MicrosoftのC++/CLI言語を使用している場合は、このオプションをYESに設定してパースサポートを有効にする必要があります。
デフォルト値は: NO です。
SIP_SUPPORT プロジェクトがsipソースのみで構成されている場合、SIP_SUPPORTタグをYESに設定します。Doxygenはそれらを通常のC++のようにパースしますが、明示的な保護キーワードがない場合、すべてのクラスがprivate継承ではなくpublic継承を使用すると仮定します。
デフォルト値は: NO です。
IDL_PROPERTY_SUPPORT MicrosoftのIDLには、プロパティのゲッターメソッドとセッターメソッドを示すpropgetおよびpropput属性があります。このオプションをYESに設定すると、Doxygenはドキュメント内でgetおよびsetメソッドをプロパティに置き換えます。これは、メソッドが実際に単純な型を取得または設定する場合にのみ機能します。そうでない場合、またはとにかくメソッドを表示したい場合は、このオプションをNOに設定する必要があります。
デフォルト値は: YES です。
DISTRIBUTE_GROUP_DOC ドキュメントでメンバーのグループ化が使用され、DISTRIBUTE_GROUP_DOCタグがYESに設定されている場合、Doxygenはグループ内の最初のメンバー（存在する場合）のドキュメントをグループの他のメンバーに再利用します。デフォルトでは、グループのすべてのメンバーは明示的にドキュメント化する必要があります。
デフォルト値は: NO です。
GROUP_NESTED_COMPOUNDS グループに構造体またはクラスを追加し、このオプションが有効になっている場合、ネストされたクラスまたは構造体も同じグループに追加されます。デフォルトではこのオプションは無効になっており、\ingroupを使用してネストされた複合を明示的に追加する必要があります。
デフォルト値は: NO です。
SUBGROUPING SUBGROUPINGタグをYESに設定すると、同じ型のクラスメンバーグループ（例えば、public関数のグループ）をその型のサブグループとして（例えば、Public Functionsセクションの下に）配置できます。サブグループ化を防止するにはNOに設定します。あるいは、これは\nosubgroupingコマンドを使用してクラスごとに設定できます。
デフォルト値は: YES です。
INLINE_GROUPED_CLASSES INLINE_GROUPED_CLASSESタグがYESに設定されている場合、クラス、構造体、および共用体は、別々のページ（HTMLおよびManページの場合）またはセクション（
およびRTFの場合）ではなく、それらが含まれるグループ内（例: \ingroupを使用）に表示されます。
この機能はSEPARATE_MEMBER_PAGESと組み合わせて機能しないことに注意してください。
デフォルト値は: NO です。
INLINE_SIMPLE_STRUCTS INLINE_SIMPLE_STRUCTSタグがYESに設定されている場合、パブリックデータフィールドまたは単純なtypedefフィールドのみを持つ構造体、クラス、および共用体は、それらが定義されているスコープ（つまり、ファイル、名前空間、またはグループドキュメント）のドキュメントにインラインで表示されます。ただし、このスコープがドキュメント化されている場合に限ります。NOに設定されている場合、構造体、クラス、および共用体は、個別のページ（HTMLおよびManページの場合）またはセクション（およびRTFの場合）に表示されます。
デフォルト値は: NO です。
TYPEDEF_HIDES_STRUCT TYPEDEF_HIDES_STRUCTタグが有効になっている場合、構造体、共用体、または列挙型のtypedefは、typedefの名前を持つ構造体、共用体、または列挙型としてドキュメント化されます。したがって、typedef struct TypeS {} TypeTは、TypeTという名前の構造体としてドキュメントに表示されます。無効になっている場合、typedefはファイル、名前空間、またはクラスのメンバーとして表示されます。そして、構造体はTypeSという名前になります。これは、コーディング規約がすべての複合型をtypedefし、typedefのみを参照し、タグ名は決して参照しないと規定しているCコードの場合に通常役立ちます。
デフォルト値は: NO です。
LOOKUP_CACHE_SIZE シンボルルックアップキャッシュのサイズは、LOOKUP_CACHE_SIZEを使用して設定できます。このキャッシュは、名前とスコープが与えられたシンボルを解決するために使用されます。これはコストのかかるプロセスであり、同じシンボルがコード内に複数回出現することが多いため、Doxygenは事前に解決されたシンボルのキャッシュを保持します。キャッシュが小さすぎるとDoxygenの動作が遅くなります。キャッシュが大きすぎるとメモリが無駄になります。キャッシュサイズは次の式で与えられます: 
。有効な範囲は0..9で、デフォルトは0であり、これは
シンボルのキャッシュサイズに対応します。実行終了時、Doxygenはキャッシュの使用状況を報告し、速度の観点から最適なキャッシュサイズを提案します。
最小値: 0、最大値: 9、デフォルト値: 0。
NUM_PROC_THREADS NUM_PROC_THREADSは、Doxygenが処理中に使用できるスレッドの数を指定します。0に設定すると、Doxygenはシステムの利用可能なコア数に基づいて決定します。明示的に0より大きい値を設定することで、CPU負荷と処理速度のバランスをより細かく制御できます。現時点では、入力処理のみが複数のスレッドを使用して実行できます。これはまだ実験的な機能であるため、デフォルトは1に設定されており、実質的に並列処理は無効になっています。問題が発生した場合は報告してください。dotグラフの並列生成は、DOT_NUM_THREADS設定によって制御されます。
最小値: 0、最大値: 32、デフォルト値: 1。
TIMESTAMP TIMESTAMPタグがNO以外に設定されている場合、生成される各ページには、ページが生成された日付または日時が含まれます。これをNOに設定すると、複数回の実行結果を比較する際に役立ちます。
指定可能な値は: YES、NO、DATETIME、DATEです。
デフォルト値は: NO です。
EXTRACT_ALL EXTRACT_ALLタグがYESに設定されている場合、Doxygenは、ドキュメントに利用可能な情報がなくても、ドキュメント内のすべてのエンティティがドキュメント化されていると仮定します。プライベートクラスメンバーと静的ファイルメンバーは、それぞれEXTRACT_PRIVATEとEXTRACT_STATICタグがYESに設定されていない限り非表示になります。
WARNINGSがYESに設定されている場合に通常生成される、ドキュメント化されていないメンバーに関する警告も無効にします。デフォルト値は: NO です。
EXTRACT_PRIVATE EXTRACT_PRIVATEタグがYESに設定されている場合、クラスのすべてのプライベートメンバーがドキュメントに含まれます。
デフォルト値は: NO です。
EXTRACT_PRIV_VIRTUAL EXTRACT_PRIV_VIRTUALタグがYESに設定されている場合、クラスのドキュメント化されたプライベート仮想メソッドがドキュメントに含まれます。
デフォルト値は: NO です。
EXTRACT_PACKAGE EXTRACT_PACKAGEタグがYESに設定されている場合、パッケージまたは内部スコープを持つすべてのメンバーがドキュメントに含まれます。
デフォルト値は: NO です。
EXTRACT_STATIC EXTRACT_STATICタグがYESに設定されている場合、ファイルのすべての静的メンバーがドキュメントに含まれます。
デフォルト値は: NO です。
EXTRACT_LOCAL_CLASSES EXTRACT_LOCAL_CLASSESタグがYESに設定されている場合、ソースファイルでローカルに定義されたクラス（および構造体）がドキュメントに含まれます。NOに設定されている場合、ヘッダーファイルで定義されたクラスのみが含まれます。Javaソースには影響しません。
デフォルト値は: YES です。
EXTRACT_LOCAL_METHODS このフラグはObjective-Cコードにのみ役立ちます。YESに設定されている場合、実装セクションで定義されているがインターフェースには定義されていないローカルメソッドがドキュメントに含まれます。NOに設定されている場合、インターフェース内のメソッドのみが含まれます。
デフォルト値は: NO です。
EXTRACT_ANON_NSPACES このフラグがYESに設定されている場合、匿名名前空間のメンバーが抽出され、ドキュメントには「'anonymous_namespace{file}'」という名前の名前空間として表示されます。ここでfileは、匿名名前空間を含むファイルのベース名に置き換えられます。デフォルトでは匿名名前空間は非表示です。
デフォルト値は: NO です。
RESOLVE_UNNAMED_PARAMS このフラグがYESに設定されている場合、宣言内の名前のないパラメータの名前は、対応する定義によって決定されます。デフォルトでは、名前のないパラメータは出力で名前のないままになります。
デフォルト値は: YES です。
HIDE_UNDOC_MEMBERS HIDE_UNDOC_MEMBERSタグがYESに設定されている場合、Doxygenはドキュメント化されたクラスまたはファイル内のすべてのドキュメント化されていないメンバーを非表示にします。NOに設定されている場合、これらのメンバーはさまざまな概要に含まれますが、ドキュメントセクションは生成されません。このオプションは、EXTRACT_ALLが有効になっている場合は影響しません。
デフォルト値は: NO です。
HIDE_UNDOC_CLASSES HIDE_UNDOC_CLASSESタグがYESに設定されている場合、Doxygenはクラス階層で通常表示されるすべてのドキュメント化されていないクラスを非表示にします。NOに設定されている場合、これらのクラスはさまざまな概要に含まれます。このオプションは、有効になっている場合にドキュメント化されていないC++コンセプトも非表示にします。このオプションは、EXTRACT_ALLが有効になっている場合は影響しません。
デフォルト値は: NO です。
HIDE_UNDOC_NAMESPACES HIDE_UNDOC_NAMESPACESタグがYESに設定されている場合、Doxygenは名前空間階層で通常表示されるすべてのドキュメント化されていない名前空間を非表示にします。NOに設定されている場合、これらの名前空間はさまざまな概要に含まれます。このオプションは、EXTRACT_ALLが有効になっている場合は影響しません。
デフォルト値は: YES です。
HIDE_FRIEND_COMPOUNDS HIDE_FRIEND_COMPOUNDSタグがYESに設定されている場合、Doxygenはすべてのフレンド宣言を非表示にします。NOに設定されている場合、これらの宣言はドキュメントに含まれます。
デフォルト値は: NO です。
HIDE_IN_BODY_DOCS HIDE_IN_BODY_DOCSタグがYESに設定されている場合、Doxygenは関数の本体内にあるドキュメントブロックを非表示にします。NOに設定されている場合、これらのブロックは関数の詳細なドキュメントブロックに追加されます。
デフォルト値は: NO です。
INTERNAL_DOCS INTERNAL_DOCSタグは、\internalコマンドの後に記述されたドキュメントを含めるかどうかを決定します。タグがNOに設定されている場合、ドキュメントは除外されます。内部ドキュメントを含めるにはYESに設定します。
デフォルト値は: NO です。
CASE_SENSE_NAMES CASE_SENSE_NAMESオプションを正しく設定することで、Doxygenは基盤となるファイルシステムの機能をより適切に一致させることができます。
ファイルシステムが大文字と小文字を区別する場合（つまり、同じディレクトリ内に名前が大文字と小文字のみ異なるファイルをサポートする場合）、入力にそのようなファイルが出現した場合に適切に処理するために、このオプションをYESに設定する必要があります。
大文字と小文字を区別しないファイルシステムの場合、CLASSとClassのように大文字と小文字のみが異なるシンボル用に書き込まれた出力ファイルを適切に処理し、正確な大文字と小文字の指定なしにファイルへの参照をサポートするために、このオプションをNOに設定する必要があります。
Windows（Cygwinを含む）およびmacOSでは、ユーザーはこのオプションを通常NOに設定すべきですが、Linuxまたはその他のUnix系OSでは通常YESに設定すべきです。
指定可能な値は: SYSTEM、NO、YESです。
デフォルト値は: SYSTEM です。
HIDE_SCOPE_NAMES HIDE_SCOPE_NAMESタグがNOに設定されている場合、Doxygenはドキュメント内でメンバーを完全なクラスと名前空間のスコープとともに表示します。YESに設定されている場合、スコープは非表示になります。
デフォルト値は: NO です。
HIDE_COMPOUND_REFERENCE HIDE_COMPOUND_REFERENCEタグがNO（デフォルト）に設定されている場合、Doxygenはページのタイトルに「Class Reference」などの追加テキストを付加します。YESに設定されている場合、複合参照は非表示になります。
デフォルト値は: NO です。
SHOW_HEADERFILE SHOW_HEADERFILEタグがYESに設定されている場合、クラスのドキュメントには、そのクラスを使用するためにどのファイルをインクルードする必要があるかが表示されます。
デフォルト値は: YES です。
SHOW_INCLUDE_FILES SHOW_INCLUDE_FILESタグがYESに設定されている場合、Doxygenはファイルによってインクルードされるファイルのリストを、そのファイルのドキュメントに配置します。
デフォルト値は: YES です。
SHOW_GROUPED_MEMB_INC SHOW_GROUPED_MEMB_INCタグがYESに設定されている場合、Doxygenはグループ化された各メンバーについて、そのメンバーを使用するためにどのファイルをインクルードすべきかを読者に伝えるインクルードステートメントをドキュメントに追加します。
デフォルト値は: NO です。
FORCE_LOCAL_INCLUDES FORCE_LOCAL_INCLUDESタグがYESに設定されている場合、Doxygenはドキュメントでインクルードファイルを山括弧ではなく二重引用符で表示します。
デフォルト値は: NO です。
INLINE_INFO INLINE_INFOタグがYESに設定されている場合、インラインメンバーのドキュメントに[inline]タグが挿入されます。
デフォルト値は: YES です。
SORT_MEMBER_DOCS SORT_MEMBER_DOCSタグがYESに設定されている場合、Doxygenはファイルおよびクラスメンバーの（詳細な）ドキュメントをメンバー名でアルファベット順にソートします。NOに設定されている場合、メンバーは宣言順に表示されます。
デフォルト値は: YES です。
SORT_BRIEF_DOCS SORT_BRIEF_DOCSタグがYESに設定されている場合、Doxygenはファイル、名前空間、クラスメンバーの簡単な説明をメンバー名でアルファベット順にソートします。NOに設定されている場合、メンバーは宣言順に表示されます。これはクラスリスト内のクラスの順序にも影響することに注意してください。
デフォルト値は: NO です。
SORT_MEMBERS_CTORS_1ST SORT_MEMBERS_CTORS_1STタグがYESに設定されている場合、Doxygenはクラスメンバーの（簡単な説明と詳細な説明の）ドキュメントを、コンストラクタとデストラクタが最初にリストされるようにソートします。NOに設定されている場合、コンストラクタはSORT_BRIEF_DOCSとSORT_MEMBER_DOCSで定義されたそれぞれの順序で表示されます。
SORT_BRIEF_DOCSがNOに設定されている場合、このオプションは簡単なメンバードキュメントのソートには無視されます。SORT_MEMBER_DOCSがNOに設定されている場合、このオプションは詳細なメンバードキュメントのソートには無視されます。デフォルト値は: NO です。
SORT_GROUP_NAMES SORT_GROUP_NAMESタグがYESに設定されている場合、Doxygenはグループ名の階層をアルファベット順にソートします。NOに設定されている場合、グループ名は定義された順序で表示されます。
デフォルト値は: NO です。
SORT_BY_SCOPE_NAME SORT_BY_SCOPE_NAMEタグがYESに設定されている場合、クラスリストは名前空間を含む完全修飾名でソートされます。NOに設定されている場合、クラスリストはクラス名のみでソートされ、名前空間部分は含まれません。
HIDE_SCOPE_NAMESがYESに設定されている場合、あまり有用ではありません。デフォルト値は: NO です。
STRICT_PROTO_MATCHING STRICT_PROTO_MATCHINGオプションが有効になっていて、Doxygenが関数のすべてのパラメータの適切な型解決に失敗した場合、候補が1つしかない場合や単純な文字列マッチングでどの候補を選択すべきかが明らかである場合でも、メンバ関数のプロトタイプと実装間のマッチングを拒否します。STRICT_PROTO_MATCHINGを無効にすることで、Doxygenはこのような場合でもプロトタイプと実装間のマッチングを受け入れます。
デフォルト値は: NO です。
GENERATE_TODOLIST GENERATE_TODOLISTタグは、TODOリストを有効（YES）または無効（NO）にするために使用できます。このリストは、ドキュメントに\todoコマンドを記述することによって作成されます。
デフォルト値は: YES です。
GENERATE_TESTLIST GENERATE_TESTLISTタグは、テストリストを有効（YES）または無効（NO）にするために使用できます。このリストは、ドキュメントに\testコマンドを記述することによって作成されます。
デフォルト値は: YES です。
GENERATE_BUGLIST GENERATE_BUGLISTタグは、バグリストを有効（YES）または無効（NO）にするために使用できます。このリストは、ドキュメントに\bugコマンドを記述することによって作成されます。
デフォルト値は: YES です。
GENERATE_DEPRECATEDLIST GENERATE_DEPRECATEDLISTタグは、非推奨リストを有効（YES）または無効（NO）にするために使用できます。このリストは、ドキュメントに\deprecatedコマンドを記述することによって作成されます。
デフォルト値は: YES です。
ENABLED_SECTIONS ENABLED_SECTIONSタグは、\if <section_label> ... \endifおよび\cond <section_label> ... \endcondブロックでマークされた条件付きドキュメントセクションを有効にするために使用できます。
MAX_INITIALIZER_LINES MAX_INITIALIZER_LINESタグは、変数またはマクロ/定義の初期値がドキュメントに表示されるために持つことができる最大行数を決定します。イニシャライザがここで指定されたよりも多くの行で構成されている場合、それは非表示になります。イニシャライザを完全に非表示にするには0の値を使用します。個々の変数およびマクロ/定義の値の表示は、この設定に関係なく、ドキュメント内の\showinitializerまたは\hideinitializerコマンドを使用して制御できます。
最小値: 0、最大値: 10000、デフォルト値: 30。
SHOW_USED_FILES クラスと構造体のドキュメントの下部に生成されるファイルリストを無効にするには、SHOW_USED_FILESタグをNOに設定します。YESに設定されている場合、リストにはドキュメントの生成に使用されたファイルが記載されます。
デフォルト値は: YES です。
SHOW_FILES ファイルページの生成を無効にするには、SHOW_FILESタグをNOに設定します。これにより、クイックインデックスおよびフォルダーツリービュー（指定されている場合）からファイルエントリが削除されます。
デフォルト値は: YES です。
SHOW_NAMESPACES 名前空間ページの生成を無効にするには、SHOW_NAMESPACESタグをNOに設定します。これにより、クイックインデックスおよびフォルダーツリービュー（指定されている場合）から名前空間エントリが削除されます。
デフォルト値は: YES です。
FILE_VERSION_FILTER FILE_VERSION_FILTERタグは、Doxygenが各ファイルの現在のバージョン（通常はバージョン管理システムから）を取得するために呼び出すプログラムまたはスクリプトを指定するために使用できます。Doxygenは、command input-fileというコマンドを実行（popen()経由）してプログラムを呼び出します。ここで、commandはFILE_VERSION_FILTERタグの値であり、input-fileはDoxygenが提供する入力ファイルの名前です。プログラムが標準出力に書き込むものはすべてファイルバージョンとして使用されます。
Unix用フィルタとしてシェルスクリプトを使用する例
FILE_VERSION_FILTER = "/bin/sh versionfilter.sh"
CVS用シェルスクリプトの例
#!/bin/sh cvs status $1 | sed -n 's/^[ \]*Working revision:[ \t]*\([0-9][0-9\.]*\).*/\1/p'
Subversion用シェルスクリプトの例
#!/bin/sh
svn stat -v $1 | sed -n 's/^[ A-Z?\*|!]\{1,15\}/r/;s/ \{1,15\}/\/r/;s/ .*//p'
ClearCase用フィルタの例
FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
LAYOUT_FILE LAYOUT_FILEタグは、Doxygenによってパースされるレイアウトファイルを指定するために使用できます。レイアウトファイルは、生成される出力ファイルの全体構造を出力形式に依存しない方法で制御します。Doxygenのデフォルトを表すレイアウトファイルを作成するには、-lオプションを付けてDoxygenを実行します。オプションの後にファイル名を指定することもできます。省略した場合、DoxygenLayout.xmlがレイアウトファイル名として使用されます。詳細については、セクション「ページのレイアウトを変更する」も参照してください。DoxygenLayout.xmlという名前のファイルを含むディレクトリからDoxygenを実行した場合、LAYOUT_FILEタグが空のままでもDoxygenはそれを自動的にパースすることに注意してください。
CITE_BIB_FILES CITE_BIB_FILESタグは、参照定義を含む1つ以上のbibファイルを指定するために使用できます。これは.bibファイルのリストである必要があります。.bib拡張子は、省略された場合でも自動的に追加されます。これには、bibtexツールがインストールされている必要があります。詳細については、https://en.wikipedia.org/wiki/BibTeX を参照してください。の場合、書誌のスタイルはLATEX_BIB_STYLEを使用して制御できます。この機能を使用するには、検索パスにbibtexとperlがある必要があります。参照の作成方法については、\citeも参照してください。
EXTERNAL_TOOL_PATH EXTERNAL_TOOL_PATHタグは、latexやgsなどの外部ツールを見つけられるように、検索パス（PATH環境変数）を拡張するために使用できます。EXTERNAL_TOOL_PATHで指定されたディレクトリは、PATH変数によってすでに指定されているパスの前に、指定された順序で追加されます。PATHへの変更はすべて無視されるためです。macOSでの典型的な例として、次のように設定します。EXTERNAL_TOOL_PATH = /Library/TeX/texbin /usr/local/bin標準パスとともに、Doxygenが外部ツールを起動する際に使用する完全な検索パスは次のようになります。
PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin
QUIET QUIETタグは、Doxygenによって標準出力に生成されるメッセージのオン/オフを切り替えるために使用できます。QUIETがYESに設定されている場合、メッセージはオフになります。
デフォルト値は: NO です。
WARNINGS WARNINGSタグは、Doxygenによって標準エラー出力（stderr）に生成される警告メッセージのオン/オフを切り替えるために使用できます。WARNINGSがYESに設定されている場合、警告はオンになります。
ヒント: ドキュメント作成中は警告をオンにしてください。
デフォルト値は: YES です。
WARN_IF_UNDOCUMENTED WARN_IF_UNDOCUMENTEDタグがYESに設定されている場合、Doxygenはドキュメント化されていないメンバーについて警告を生成します。EXTRACT_ALLがYESに設定されている場合、このフラグは自動的に無効になります。
デフォルト値は: YES です。
WARN_IF_DOC_ERROR WARN_IF_DOC_ERRORタグがYESに設定されている場合、Doxygenは、ドキュメント化された関数の一部のパラメータを二重にドキュメント化したり、存在しないパラメータをドキュメント化したり、マークアップコマンドを誤って使用したりするなど、ドキュメント内の潜在的なエラーについて警告を生成します。
デフォルト値は: YES です。
WARN_IF_INCOMPLETE_DOC WARN_IF_INCOMPLETE_DOCがYESに設定されている場合、Doxygenは不完全な関数パラメータドキュメントについて警告します。NOに設定されている場合、Doxygenは一部のパラメータにドキュメントがなくても警告なしに受け入れます。
デフォルト値は: YES です。
WARN_NO_PARAMDOC このWARN_NO_PARAMDOCオプションを有効にすると、ドキュメント化されているが、そのパラメータまたは戻り値のドキュメントがない関数について警告を受け取ることができます。NOに設定されている場合、Doxygenは誤ったパラメータドキュメントについてのみ警告し、ドキュメントの欠如については警告しません。EXTRACT_ALLがYESに設定されている場合、このフラグは自動的に無効になります。WARN_IF_INCOMPLETE_DOCも参照してください。
デフォルト値は: NO です。
WARN_IF_UNDOC_ENUM_VAL WARN_IF_UNDOC_ENUM_VALオプションがYESに設定されている場合、Doxygenはドキュメント化されていない列挙値について警告します。NOに設定されている場合、Doxygenはドキュメント化されていない列挙値を受け入れます。EXTRACT_ALLがYESに設定されている場合、このフラグは自動的に無効になります。
デフォルト値は: NO です。
WARN_LAYOUT_FILE WARN_LAYOUT_FILEオプションがYESに設定されている場合、Doxygenはユーザー定義のレイアウトファイルをパースする際に発見された、要素の欠落や間違いなどの問題について警告します。詳細については、LAYOUT_FILEも参照してください。NOに設定されている場合、レイアウトファイルに関する問題は抑制されます。
デフォルト値は: YES です。
WARN_AS_ERROR WARN_AS_ERRORタグがYESに設定されている場合、Doxygenは警告に遭遇するとすぐに停止します。WARN_AS_ERRORタグがFAIL_ON_WARNINGSに設定されている場合、DoxygenはWARN_AS_ERRORタグがNOに設定されているかのように実行を継続しますが、Doxygenプロセスの最後にDoxygenは非ゼロのステータスを返します。WARN_AS_ERRORタグがFAIL_ON_WARNINGS_PRINTに設定されている場合、DoxygenはFAIL_ON_WARNINGSのように動作しますが、WARN_LOGFILEが定義されていない場合、Doxygenは警告メッセージを他のメッセージの間に書き込むのではなく、実行の最後に書き込みます。WARN_LOGFILEが定義されている場合、警告メッセージは定義されたファイルにあるだけでなく、実行の最後にも表示されます。ただし、WARN_LOGFILEが-（つまり標準出力（stdout））として定義されている場合、動作はFAIL_ON_WARNINGSの設定と同じになります。
指定可能な値は: NO、YES、FAIL_ON_WARNINGS、FAIL_ON_WARNINGS_PRINTです。
デフォルト値は: NO です。
WARN_FORMAT WARN_FORMATタグは、Doxygenが生成できる警告メッセージの形式を決定します。文字列には$file、$line、$textタグを含める必要があり、これらは警告の発信元ファイルと行番号、および警告テキストに置き換えられます。オプションで、形式には$versionを含めることができ、これはファイルのバージョン（FILE_VERSION_FILTER経由で取得できた場合）に置き換えられます。
デフォルト値は: $file:$line: $text です。
WARN_LINE_FORMAT WARN_FORMATコマンドの$text部分では、より具体的な場所への参照が与えられる可能性があります。この場所（Doxygenの外で）に簡単にジャンプできるように、ユーザーはカスタムの「切り取り」/「貼り付け」文字列を定義できます。
例
WARN_LINE_FORMAT = "'vi $file +$line'"
デフォルト値は: at line $line of file $file です。
WARN_LOGFILE WARN_LOGFILEタグは、警告およびエラーメッセージを書き込むファイルを指定するために使用できます。空白のままにすると、出力は標準エラー（stderr）に書き込まれます。指定されたファイルが書き込み用に開けない場合、警告およびエラーメッセージは標準エラーに書き込まれます。ファイルとして-が指定された場合、警告およびエラーメッセージは標準出力（stdout）に書き込まれます。
INPUT INPUTタグは、ドキュメント化されたソースファイルを含むファイルおよび/またはディレクトリを指定するために使用されます。myfile.cppのようなファイル名や/usr/src/myprojectのようなディレクトリを入力できます。ファイルまたはディレクトリはスペースで区切ります。FILE_PATTERNSおよびEXTENSION_MAPPINGも参照してください。
INPUT_ENCODING このタグは、Doxygenがパースするソースファイルの文字エンコーディングを指定するために使用できます。Doxygenは内部的にUTF-8エンコーディングを使用します。Doxygenは、トランスコーディングにlibiconv（またはlibcに組み込まれたiconv）を使用します。利用可能なエンコーディングのリストについては、libiconvのドキュメントを参照してください。
デフォルト値は: UTF-8 です。
INPUT_FILE_ENCODING このタグは、Doxygenがパースするソースファイルの文字エンコーディングを指定するために使用できます。INPUT_FILE_ENCODINGタグは、ファイルパターンごとに文字エンコーディングを指定するために使用できます。Doxygenはファイル名を各パターンと比較し、一致するものがあればデフォルトのINPUT_ENCODINGの代わりにそのエンコーディングを適用します。文字エンコーディングは、`pattern=encoding`の形式のリストです（例: *.php=ISO-8859-1）。
INPUT_ENCODINGを参照してください。FILE_PATTERNS INPUTタグの値にディレクトリが含まれている場合、FILE_PATTERNSタグを使用して、ディレクトリ内のソースファイルをフィルタリングするための1つ以上のワイルドカードパターン（例: *.cppや*.h）を指定できます。
カスタム拡張子や直接サポートされていない拡張子の場合、その拡張子に対してEXTENSION_MAPPINGも設定する必要があることに注意してください。そうしないと、Doxygenによってファイルが読み込まれません。
デフォルトでチェックされるファイルパターンのリストは、デフォルトのファイル拡張子マッピングのリストとは異なる可能性があることに注意してください。
空白のままにした場合、以下のパターンがテストされます: *.c, *.cc, *.cxx, *.cxxm, *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (Doxygen Cコメントとして提供), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf, *.ice。
RECURSIVE RECURSIVEタグは、サブディレクトリも入力ファイル検索の対象とするかどうかを指定するために使用できます。
デフォルト値は: NO です。
EXCLUDE EXCLUDE タグは、INPUT ソースファイルから除外すべきファイルやディレクトリを指定するのに使用できます。これにより、INPUT タグでルートが指定されたディレクトリツリーからサブディレクトリを簡単に除外できます。
相対パスは、Doxygen が実行されるディレクトリからの相対パスであることに注意してください。
EXCLUDE_SYMLINKS EXCLUDE_SYMLINKS タグは、シンボリックリンク（Unixファイルシステムの機能）であるファイルまたはディレクトリを入力から除外するかどうかを選択するのに使用できます。
デフォルト値は: NO です。
EXCLUDE_PATTERNS INPUT タグの値にディレクトリが含まれる場合、EXCLUDE_PATTERNS タグを使用して、それらのディレクトリから特定のファイルを除外するためのワイルドカードパターンを1つ以上指定できます。
ワイルドカードは絶対パスを持つファイルと一致することに注意してください。例えば、すべてのテストディレクトリを除外するには、パターン */test/* を使用します。
EXCLUDE_SYMBOLS EXCLUDE_SYMBOLS タグは、出力から除外すべきシンボル名（名前空間、クラス、関数など）を1つ以上指定するのに使用できます。シンボル名は、完全修飾名、単語、またはワイルドカード * を使用する場合は部分文字列になります。例: ANamespace、AClass、ANamespace::AClass、ANamespace::*Test
EXAMPLE_PATH EXAMPLE_PATH タグは、含まれるサンプルコードフラグメント（\include コマンドを参照）を含む1つ以上のファイルまたはディレクトリを指定するのに使用できます。
EXAMPLE_PATTERNS EXAMPLE_PATH タグの値にディレクトリが含まれる場合、EXAMPLE_PATTERNS タグを使用して、ディレクトリ内のソースファイルをフィルタリングするためのワイルドカードパターン（例: *.cpp や *.h）を1つ以上指定できます。空白のままにすると、すべてのファイルが含まれます。
EXAMPLE_RECURSIVE EXAMPLE_RECURSIVE タグが YES に設定されている場合、RECURSIVE タグの値に関わらず、\include または \dontinclude コマンドで使用される入力ファイルをサブディレクトリも検索します。
デフォルト値は: NO です。
IMAGE_PATH IMAGE_PATH タグは、ドキュメントに含める画像（\image コマンドを参照）を含む1つ以上のファイルまたはディレクトリを指定するのに使用できます。
INPUT_FILTER INPUT_FILTER タグは、Doxygen が各入力ファイルに対してフィルタリングするために呼び出すプログラムを指定するのに使用できます。Doxygen は、次のコマンドを実行して (popen() 経由で) フィルタプログラムを呼び出します。
<filter> <input-file>
ここで、<filter> は INPUT_FILTER タグの値であり、<input-file> は入力ファイルの名前です。Doxygen は、フィルタプログラムが標準出力に書き込む出力を利用します。FILTER_PATTERNS が指定されている場合、このタグは無視されます。
フィルタは行を追加または削除してはならないことに注意してください。これはコードがスキャンされる前に適用されますが、出力コードが生成される際には適用されません。行が追加または削除されると、アンカーが正しく配置されません。
Doxygenは、標準出力に処理され書き込まれたデータをさらに処理するために使用するため、デバッグ文や使用されたコマンド（Windowsバッチファイルの場合は常に@echo OFFを使用するなど）のような他のものは標準出力に書き込まないでください。
カスタム拡張子や直接サポートされていない拡張子の場合、ファイルがDoxygenによって適切に処理されないため、拡張子に対してEXTENSION_MAPPINGも設定する必要があることに注意してください。
FILTER_PATTERNS FILTER_PATTERNS タグは、ファイルパターンごとにフィルタを指定するのに使用できます。Doxygen はファイル名を各パターンと比較し、一致があればフィルタを適用します。フィルタは「パターン=フィルタ」（例：*.cpp=my_cpp_filter）の形式のリストです。フィルタの使用方法に関する詳細については、INPUT_FILTER を参照してください。FILTER_PATTERNS タグが空の場合、またはどのパターンもファイル名に一致しない場合、INPUT_FILTER が適用されます。
カスタム拡張子や直接サポートされていない拡張子の場合、ファイルがDoxygenによって適切に処理されないため、拡張子に対してEXTENSION_MAPPINGも設定する必要があることに注意してください。
FILTER_SOURCE_FILES FILTER_SOURCE_FILES タグが YES に設定されている場合、入力フィルタ（INPUT_FILTER を使用して設定されている場合）は、ソースファイルを閲覧するために使用される入力ファイル（つまり、SOURCE_BROWSER が YES に設定されている場合）のフィルタリングにも使用されます。
デフォルト値は: NO です。
FILTER_SOURCE_PATTERNS FILTER_SOURCE_PATTERNS タグは、ファイルパターンごとにソースフィルタを指定するのに使用できます。パターンは FILTER_PATTERN の設定（もしあれば）を上書きし、*.ext= （フィルタ名を指定しない）を使用して特定のパターンに対するソースフィルタリングを無効にすることも可能です。
このタグは、FILTER_SOURCE_FILES タグが YES に設定されている必要があります。
USE_MDFILE_AS_MAINPAGE USE_MDFILE_AS_MAINPAGE タグが入力の一部であるマークダウンファイル名を参照している場合、その内容はメインページ（index.html）に配置されます。これは、例えばGitHubにプロジェクトがあり、Doxygen出力にも導入ページを再利用したい場合に役立ちます。
IMPLICIT_DIR_DOCS IMPLICIT_DIR_DOCS タグが YES に設定されている場合、プロジェクトのルートのサブディレクトリにある README.md ファイルは、README.md が \dir、\page、または \mainpage コマンドで始まらない限り、そのサブディレクトリのドキュメントとして使用されます。NO に設定されている場合、README.md ファイルはディレクトリドキュメントとして使用されるために、明示的な \dir コマンドで始まる必要があります。
デフォルト値は: YES です。
FORTRAN_COMMENT_AFTER Fortran標準では、固定フォーマットのFortranコードでは72桁目以降のすべての文字がコメントとみなされると規定されています。一般的な拡張機能として、自動コメントが始まる前に長い行を許可することがあります。FORTRAN_COMMENT_AFTERの設定により、自動コメントが始まる前に長い行を処理することが可能になります。
最小値: 7、最大値: 10000、デフォルト値: 72。
SOURCE_BROWSER SOURCE_BROWSER タグが YES に設定されている場合、ソースファイルのリストが生成されます。ドキュメント化されたエンティティは、これらのソースと相互参照されます。
注: 生成された出力からすべてのソースコードを削除するには、VERBATIM_HEADERS も NO に設定されていることを確認してください。
デフォルト値は: NO です。
INLINE_SOURCES INLINE_SOURCES タグを YES に設定すると、関数、複数行マクロ、列挙型、またはリスト初期化された変数の本体が直接ドキュメントに含まれます。
デフォルト値は: NO です。
STRIP_CODE_COMMENTS STRIP_CODE_COMMENTS タグを YES に設定すると、Doxygen は生成されたソースコードフラグメントから特殊なコメントブロックを非表示にするように指示されます。通常のC、C++、Fortranのコメントは常に表示されたままになります。
デフォルト値は: YES です。
REFERENCED_BY_RELATION REFERENCED_BY_RELATION タグが YES に設定されている場合、各ドキュメントエンティティについて、それを参照するすべてのドキュメント関数がリストされます。
デフォルト値は: NO です。
REFERENCES_RELATION REFERENCES_RELATION タグが YES に設定されている場合、各ドキュメント関数について、その関数によって呼び出される/使用されるすべてのドキュメントエンティティがリストされます。
デフォルト値は: NO です。
REFERENCES_LINK_SOURCE REFERENCES_LINK_SOURCE タグが YES に設定されており、かつ SOURCE_BROWSER タグが YES に設定されている場合、REFERENCES_RELATION および REFERENCED_BY_RELATION リスト内の関数からのハイパーリンクはソースコードにリンクされます。そうでない場合、それらはドキュメントにリンクされます。
デフォルト値は: YES です。
SOURCE_TOOLTIPS SOURCE_TOOLTIPS が有効になっている場合（デフォルト）、ソースコード内のハイパーリンクにカーソルを合わせると、プロトタイプ、簡単な説明、定義とドキュメントへのリンクなどの追加情報がツールチップで表示されます。これによりHTMLファイルが大きくなり、大きなファイルの読み込みが少し遅くなるため、この機能を無効にすることもできます。
デフォルト値は: YES です。
このタグは、SOURCE_BROWSER タグが YES に設定されている必要があります。
USE_HTAGS USE_HTAGS タグが YES に設定されている場合、ソースコードへの参照はDoxygen組み込みのソースブラウザではなく、htags(1) ツールによって生成されたHTMLを指します。htags ツールはGNUのグローバルソースタグ付けシステムの一部です（https://www.gnu.org/software/global/global.html を参照）。バージョン4.8.6以降が必要です。
使用するには、次のようにします。
global の最新バージョンをインストールします。USE_HTAGS を有効にします。doxygen を実行します。htags を呼び出し（そしてそれはさらに gtags を呼び出す）、これらのツールはコマンドラインから利用可能でなければなりません（つまり、検索パスに存在している必要があります）。htags の出力を指すようになります。デフォルト値は: NO です。
このタグは、SOURCE_BROWSER タグが YES に設定されている必要があります。
VERBATIM_HEADERS VERBATIM_HEADERS タグが YES に設定されている場合、Doxygenはインクルードが指定されている各クラスについて、ヘッダーファイルの逐語的なコピーを生成します。これを無効にするには NO に設定します。
デフォルト値は: YES です。
CLANG_ASSISTED_PARSING CLANG_ASSISTED_PARSING タグが YES に設定されている場合、Doxygen はより正確な解析のために clang パーサーを使用しますが、パフォーマンスは低下します。これは、Doxygen の組み込みパーサーに必要な型情報が不足している、テンプレートが豊富な C++ コードで特に役立ちます。
デフォルト値は: NO です。
CLANG_ADD_INC_PATHS CLANG_ASSISTED_PARSING タグが YES に設定されており、CLANG_ADD_INC_PATHS タグも YES に設定されている場合、Doxygen は各入力ファイルのディレクトリをインクルードパスに追加します。
デフォルト値は: YES です。
このタグは、CLANG_ASSISTED_PARSING タグが YES に設定されている必要があります。
CLANG_OPTIONS Clangによる支援解析が有効になっている場合、コンパイラを呼び出す際に通常使用するコマンドラインオプションをコンパイラに提供できます。Doxygenによって、INPUTおよびINCLUDE_PATHで指定されたファイルおよびディレクトリについて、インクルードパスは既に設定されていることに注意してください。
このタグは、CLANG_ASSISTED_PARSING タグが YES に設定されている必要があります。
CLANG_DATABASE_PATH Clangアシスト解析が有効になっている場合、compile_commands.json というファイルを含むディレクトリへのパスをClangパーサーに提供できます。このファイルは、ソースファイルがビルドされた際に使用されたオプションを含むコンパイルデータベースです。これは、clang-checkのようなClangツールに -p オプションを指定するのと同等です。これらのオプションはパーサーに渡されます。CLANG_OPTIONS で指定されたオプションも追加されます。
ALPHABETICAL_INDEX ALPHABETICAL_INDEX タグが YES に設定されている場合、すべての複合体についてアルファベット順のインデックスが生成されます。プロジェクトに多くのクラス、構造体、共用体、またはインターフェースが含まれている場合は、これを有効にしてください。
デフォルト値は: YES です。
IGNORE_PREFIX IGNORE_PREFIX タグは、インデックスヘッダーの生成時に無視すべき接頭辞（または接頭辞のリスト）を指定するのに使用できます。IGNORE_PREFIX タグはクラス、関数、メンバー名に機能します。エンティティは、接頭辞を削除した後に残るエンティティ名の最初の文字の下にアルファベットリストに配置されます。
このタグは、ALPHABETICAL_INDEX タグが YES に設定されている必要があります。
GENERATE_HTML GENERATE_HTML タグが YES に設定されている場合、Doxygen は HTML 出力を生成します。
デフォルト値は: YES です。
HTML_OUTPUT HTML_OUTPUT タグは、HTML ドキュメントを配置する場所を指定するために使用されます。相対パスが入力された場合、OUTPUT_DIRECTORY の値がその前に置かれます。
デフォルトのディレクトリは html です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
HTML_FILE_EXTENSION HTML_FILE_EXTENSION タグは、生成される各HTMLページのファイル拡張子（例: .htm, .php, .asp）を指定するのに使用できます。
デフォルト値は .html です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
HTML_HEADER HTML_HEADER タグは、生成される各HTMLページにユーザー定義のHTMLヘッダーファイルを指定するのに使用できます。タグが空白の場合、Doxygen は標準ヘッダーを生成します。
有効なHTMLを得るためには、Doxygenが必要とするスクリプトやスタイルシートをすべて含むヘッダーファイルが必要です。これは使用される設定オプション（例：GENERATE_TREEVIEWの設定）に依存します。デフォルトのヘッダーから始めることを強くお勧めします。
doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFile
そしてファイル new_header.html を修正します。
Doxygenが通常使用するデフォルトのヘッダーを生成する方法については、セクションDoxygen usageも参照してください。
$title$datetime$date$time$year$showdate(<format>)$doxygenversion$projectname$projectnumber$projectbrief$projectlogo$generatedby$stylesheet$extrastylesheet$treeview$search$searchbox$mathjax$relpath^$relpath^ を使用してHTML出力ディレクトリのルートへの相対パスを生成できます。例えば、標準スタイルシートを参照するには $relpath^doxygen.css を使用します。$navpath設定に応じてヘッダーとフッターのレイアウトの違いに対応するため、ヘッダーには特別なブロックを含めることもでき、設定に応じて出力にコピーされたりスキップされたりします。そのようなブロックは次の形式をとります。
<!--BEGIN BLOCKNAME--> Some context copied when condition BLOCKNAME holds <!--END BLOCKNAME--> <!--BEGIN !BLOCKNAME--> Some context copied when condition BLOCKNAME does not hold <!--END !BLOCKNAME-->
以下のブロック名がサポートされています。
DISABLE_INDEXGENERATE_TREEVIEWSEARCHENGINEPROJECT_NAMEPROJECT_NUMBERPROJECT_BRIEFPROJECT_LOGOFULL_SIDEBARTITLEAREAこのタグは、GENERATE_HTML タグが YES に設定されている必要があります。
HTML_FOOTER HTML_FOOTER タグは、生成される各HTMLページにユーザー定義のHTMLフッターを指定するのに使用できます。タグが空白の場合、Doxygen は標準フッターを生成します。
デフォルトのフッターを生成する方法や、フッター内で使用できる特殊コマンドに関する詳細については、HTML_HEADER を参照してください。
Doxygenが通常使用するデフォルトのフッターを生成する方法については、セクションDoxygen usageも参照してください。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
HTML_STYLESHEET HTML_STYLESHEET タグは、各HTMLページで使用されるユーザー定義のカスケードスタイルシートを指定するために使用できます。HTML出力の見た目を微調整するために使用できます。空白のままにすると、Doxygen はデフォルトのスタイルシートを生成します。
Doxygen が通常使用するスタイルシートの生成方法については、セクション Doxygen usage も参照してください。
HTML_STYLESHEET）は将来廃止される可能性があるため、より堅牢なHTML_EXTRA_STYLESHEETを使用することをお勧めします。このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
HTML_EXTRA_STYLESHEET HTML_EXTRA_STYLESHEET タグは、Doxygen によって作成された標準スタイルシートの後に含まれる追加のユーザー定義カスケードスタイルシートを指定するのに使用できます。このオプションを使用すると、特定のスタイル側面を上書きできます。これは、標準スタイルシートを置き換えずに、将来の更新に対してより堅牢であるため、HTML_STYLESHEET を使用するよりも推奨されます。Doxygen はスタイルシートファイルを HTML 出力ディレクトリにコピーします。body {
background-color: #CCC;
color: black;
margin: 0;
}
div.contents {
margin-bottom: 10px;
padding: 12px;
margin-left: auto;
margin-right: auto;
width: 960px;
background-color: white;
border-radius: 8px;
}
#titlearea {
background-color: white;
}
hr.footer {
display: none;
}
.footer {
background-color: #AAA;
}
YES に設定されている必要があります。HTML_EXTRA_FILES HTML_EXTRA_FILES タグは、HTML出力ディレクトリにコピーする必要がある追加の画像やその他のソースファイルを1つ以上指定するのに使用できます。これらのファイルは、基本HTML出力ディレクトリにコピーされることに注意してください。これらのファイルをロードするには、HTML_HEADER および/または HTML_FOOTER ファイルで $relpath^ マーカーを使用します。HTML_STYLESHEET ファイルでは、ファイル名のみを使用します。また、ファイルはそのままコピーされ、コマンドやマーカーは利用できません。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
HTML_COLORSTYLE HTML_COLORSTYLE タグは、生成されるHTML出力をダークテーマまたはライトテーマでレンダリングするかどうかを指定するために使用できます。
取りうる値は：LIGHT（常にライトモード出力を生成）、DARK（常にダークモード出力を生成）、AUTO_LIGHT（ユーザー設定に基づいて自動的にモードを設定、設定がない場合はライトモードを使用（デフォルト））、AUTO_DARK（ユーザー設定に基づいて自動的にモードを設定、設定がない場合はダークモードを使用）、そして TOGGLE（ユーザーがボタンでライトモードとダークモードを切り替えられるようにする）です。
デフォルト値は AUTO_LIGHT です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
HTML_COLORSTYLE_HUE HTML_COLORSTYLE_HUE タグは、HTML出力の色の色相を制御します。Doxygen は、この色相に合わせてスタイルシートと背景画像の色彩を調整します。色相はカラーホイール上の角度として指定されます。詳細については、https://en.wikipedia.org/wiki/Hue を参照してください。たとえば、値0は赤、60は黄色、120は緑、180はシアン、240は青、300は紫、そして360は再び赤を表します。
最小値: 0、最大値: 359、デフォルト値: 220。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
HTML_COLORSTYLE_SAT HTML_COLORSTYLE_SAT タグは、HTML出力における色の純度（または彩度）を制御します。値が0の場合、出力はグレースケールのみを使用します。値が255の場合、最も鮮やかな色が生成されます。
最小値: 0、最大値: 255、デフォルト値: 100。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
HTML_COLORSTYLE_GAMMA HTML_COLORSTYLE_GAMMA タグは、HTML出力の色における輝度成分に適用されるガンマ補正を制御します。100未満の値は徐々に出力を明るくし、100を超える値は出力を暗くします。値が100で割られたものが実際のガンマ値であり、80はガンマ0.8を表し、220はガンマ2.2を表し、100はガンマを変更しません。
最小値: 40、最大値: 240、デフォルト値: 80。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
HTML_DYNAMIC_MENUS HTML_DYNAMIC_MENUS タグが YES に設定されている場合、生成されるHTMLドキュメントには、JavaScriptを介して動的に作成される垂直ナビゲーションメニューを持つメインインデックスが含まれます。無効になっている場合、ナビゲーションインデックスは、各HTMLページに静的に埋め込まれた複数のレベルのタブで構成されます。Qtヘルプブラウザなど、JavaScriptをサポートしないブラウザをサポートするには、このオプションを無効にしてください。
デフォルト値は: YES です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
HTML_DYNAMIC_SECTIONS HTML_DYNAMIC_SECTIONS タグが YES に設定されている場合、生成されたHTMLドキュメントには、ページがロードされた後に非表示にしたり表示したりできるセクションが含まれます。
デフォルト値は: NO です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
HTML_CODE_FOLDING HTML_CODE_FOLDING タグが YES に設定されている場合、生成されたHTMLソースコードにおいて、クラスや関数を動的に折りたたんだり展開したりできます。
デフォルト値は: YES です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
HTML_COPY_CLIPBOARD HTML_COPY_CLIPBOARD タグが YES に設定されている場合、Doxygenはコードおよびテキストフラグメントの右上隅に、ユーザーがそのコンテンツをクリップボードにコピーできるようにするアイコンを表示します。これはブラウザがサポートし、ウェブページが安全なコンテキスト（つまり、https: または file: プロトコルを使用）を介して提供される場合にのみ機能することに注意してください。
デフォルト値は: YES です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
HTML_PROJECT_COOKIE Doxygenはいくつかの設定をブラウザに永続的に保存します（例：クッキーを介して）。デフォルトでは、これらの設定はすべてのプロジェクトにわたってDoxygenによって生成されたすべてのHTMLページに適用されます。HTML_PROJECT_COOKIE タグを使用すると、プロジェクト固有のキーの下に設定を保存できるため、ユーザー設定が個別に保存されます。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
HTML_INDEX_NUM_ENTRIES HTML_INDEX_NUM_ENTRIES を使用すると、様々なツリー構造のインデックスに最初に表示されるエントリの推奨数を制御できます。ユーザーは後で動的にエントリを展開したり折りたたんだりできます。Doxygenは、指定されたエントリ数まで（完全に折りたたまれたツリーが既にこの数を超えている場合を除く）ツリーを展開します。したがって、エントリ数を1に設定すると、デフォルトでは完全に折りたたまれたツリーが生成されます。0は無限のエントリ数を表す特殊な値であり、デフォルトでは完全に展開されたツリーが生成されます。
最小値: 0、最大値: 9999、デフォルト値: 100。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
GENERATE_DOCSET GENERATE_DOCSET タグが YES に設定されている場合、OSX 10.5 (Leopard) で導入された Apple の Xcode 3 統合開発環境 の入力として使用できる追加のインデックスファイルが生成されます。ドキュメンテーションセットを作成するために、Doxygen は HTML 出力ディレクトリに Makefile を生成します。make を実行すると、そのディレクトリにドキュメンテーションセットが生成され、make install を実行すると、~/Library/Developer/Shared/Documentation/DocSets にドキュメンテーションセットがインストールされ、Xcode が起動時にそれを見つけられるようになります。詳細については、https://developer.apple.com/library/archive/featuredarticles/DoxygenXcode/_index.html を参照してください。
デフォルト値は: NO です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
DOCSET_FEEDNAME このタグはdocsetフィードの名前を決定します。ドキュメンテーションフィードは、単一のプロバイダー（会社や製品スイートなど）からの複数のドキュメンテーションセットをグループ化できる傘を提供します。
デフォルト値は Doxygen generated docs です。
このタグは、GENERATE_DOCSET タグが YES に設定されている必要があります。
DOCSET_FEEDURL このタグはdocsetフィードのURLを決定します。ドキュメンテーションフィードは、単一のプロバイダー（会社や製品スイートなど）からの複数のドキュメンテーションセットをグループ化できる傘を提供します。
このタグは、GENERATE_DOCSET タグが YES に設定されている必要があります。
DOCSET_BUNDLE_ID このタグは、ドキュメンテーションセットバンドルを一意に識別する文字列を指定します。これは、com.mycompany.MyDocSet のような逆ドメイン名形式の文字列である必要があります。Doxygen は名前に .docset を追加します。
デフォルト値は org.doxygen.Project です。
このタグは、GENERATE_DOCSET タグが YES に設定されている必要があります。
DOCSET_PUBLISHER_ID DOCSET_PUBLISHER_ID タグは、ドキュメンテーションのパブリッシャーを一意に識別する文字列を指定します。これは、com.mycompany.MyDocSet.documentation のような逆ドメイン名形式の文字列である必要があります。
デフォルト値は org.doxygen.Publisher です。
このタグは、GENERATE_DOCSET タグが YES に設定されている必要があります。
DOCSET_PUBLISHER_NAME DOCSET_PUBLISHER_NAME タグは、ドキュメンテーションのパブリッシャーを識別します。
デフォルト値は Publisher です。
このタグは、GENERATE_DOCSET タグが YES に設定されている必要があります。
GENERATE_HTMLHELP GENERATE_HTMLHELP タグが YES に設定されている場合、Doxygenは3つの追加のHTMLインデックスファイル（index.hhp、index.hhc、index.hhk）を生成します。index.hhp は、Windows上のMicrosoft HTML Help Workshopで読み取ることができるプロジェクトファイルです。2021年初頭にMicrosoftは、ダウンロードリンクなどを含む元のページをオフラインにしました（HTML Help Workshopはすでに長年メンテナンスモードでした）。HTML Help Workshopは、Webアーカイブからインストール実行ファイルをダウンロードできます。
HTML Help Workshop には、Doxygen によって生成されたすべての HTML 出力を単一のコンパイル済み HTML ファイル（.chm）に変換できるコンパイラが含まれています。コンパイル済み HTML ファイルは現在、Windows 98 のヘルプ形式として使用されており、将来的にはすべての Windows プラットフォームで古い Windows ヘルプ形式（.hlp）に置き換えられます。圧縮 HTML ファイルには、インデックス、目次も含まれており、ドキュメント内の単語を検索できます。HTML Workshop には、圧縮 HTML ファイル用のビューアも含まれています。
デフォルト値は: NO です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
CHM_FILE CHM_FILE タグは、生成される .chm ファイルのファイル名を指定するのに使用できます。結果をhtml出力ディレクトリに書き込みたくない場合は、ファイルの前にパスを追加できます。
このタグは、GENERATE_HTMLHELP タグが YES に設定されている必要があります。
HHC_LOCATION HHC_LOCATION タグは、HTMLヘルプコンパイラ（hhc.exe）の場所（ファイル名を含む絶対パス）を指定するのに使用できます。空でない場合、Doxygen は生成された index.hhp に対してHTMLヘルプコンパイラを実行しようとします。
ファイルはフルパスで指定する必要があります。
このタグは、GENERATE_HTMLHELP タグが YES に設定されている必要があります。
GENERATE_CHI GENERATE_CHI フラグは、個別の .chi インデックスファイルを生成するか（YES）、またはメインの .chm ファイルに含めるか（NO）を制御します。
デフォルト値は: NO です。
このタグは、GENERATE_HTMLHELP タグが YES に設定されている必要があります。
CHM_INDEX_ENCODING CHM_INDEX_ENCODING は、HtmlHelpのインデックス（hhk）、コンテンツ（hhc）、およびプロジェクトファイルのコンテンツをエンコードするために使用されます。
このタグは、GENERATE_HTMLHELP タグが YES に設定されている必要があります。
BINARY_TOC BINARY_TOC フラグは、.chm ファイルでバイナリ目次が生成されるか（YES）、通常の目次が生成されるか（NO）を制御します。さらに、Previous および Next ボタンを有効にします。
デフォルト値は: NO です。
このタグは、GENERATE_HTMLHELP タグが YES に設定されている必要があります。
TOC_EXPAND TOC_EXPAND フラグは、HTMLヘルプドキュメントの目次およびツリービューにグループメンバーの追加項目を追加するために YES に設定できます。
デフォルト値は: NO です。
このタグは、GENERATE_HTMLHELP タグが YES に設定されている必要があります。
SITEMAP_URL SITEMAP_URL タグは、生成されたドキュメントがユーザーによってサーバーに配置される場所の完全なURLを指定するために使用されます。生成されたサイトマップは sitemap.xml と呼ばれ、HTML_OUTPUT で指定されたディレクトリに配置されます。SITEMAP_URL が指定されていない場合、サイトマップは生成されません。サイトマッププロトコルに関する情報については、https://www.sitemaps.org を参照してください。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
GENERATE_QHP GENERATE_QHP タグが YES に設定されており、QHP_NAMESPACE と QHP_VIRTUAL_FOLDER の両方が設定されている場合、Qt の qhelpgenerator の入力として使用できる追加のインデックスファイルが生成され、生成された HTML ドキュメントの Qt 圧縮ヘルプ（.qch）を生成できます。
デフォルト値は: NO です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
QCH_FILE QHG_LOCATION タグが指定されている場合、QCH_FILE タグを使用して結果の .qch ファイルのファイル名を指定できます。指定されたパスは、HTML出力フォルダからの相対パスです。
このタグは、GENERATE_QHP タグが YES に設定されている必要があります。
QHP_NAMESPACE QHP_NAMESPACE タグは、Qt Help Project 出力を生成する際に使用する名前空間を指定します。詳細については、Qt Help Project / Namespace を参照してください。
デフォルト値は org.doxygen.Project です。
このタグは、GENERATE_QHP タグが YES に設定されている必要があります。
QHP_VIRTUAL_FOLDER QHP_VIRTUAL_FOLDER タグは、Qt Help Project 出力を生成する際に使用する名前空間を指定します。詳細については、Qt Help Project / Virtual Folders を参照してください。
デフォルト値は doc です。
このタグは、GENERATE_QHP タグが YES に設定されている必要があります。
QHP_CUST_FILTER_NAME QHP_CUST_FILTER_NAME タグが設定されている場合、追加するカスタムフィルタの名前を指定します。詳細については、Qt Help Project / Custom Filters を参照してください。
このタグは、GENERATE_QHP タグが YES に設定されている必要があります。
QHP_CUST_FILTER_ATTRS QHP_CUST_FILTER_ATTRS タグは、追加するカスタムフィルタの属性リストを指定します。詳細については、Qt Help Project / Custom Filters を参照してください。
このタグは、GENERATE_QHP タグが YES に設定されている必要があります。
QHP_SECT_FILTER_ATTRS QHP_SECT_FILTER_ATTRS タグは、このプロジェクトのフィルタセクションが一致する属性のリストを指定します。Qt Help Project / Filter Attributes。
このタグは、GENERATE_QHP タグが YES に設定されている必要があります。
QHG_LOCATION QHG_LOCATION タグは、Qt の qhelpgenerator の場所（ファイル名を含む絶対パス）を指定するのに使用できます。空でない場合、Doxygen は生成された .qhp ファイルに対して qhelpgenerator を実行しようとします。
このタグは、GENERATE_QHP タグが YES に設定されている必要があります。
GENERATE_ECLIPSEHELP GENERATE_ECLIPSEHELP タグが YES に設定されている場合、追加のインデックスファイルがHTMLファイルとともに生成され、それらが Eclipse ヘルププラグインを構成します。
このプラグインをインストールして Eclipse のヘルプコンテンツメニューで使用可能にするには、HTMLおよびXMLファイルを含むディレクトリの内容をEclipseのpluginsディレクトリにコピーする必要があります。pluginsディレクトリ内のディレクトリ名は、ECLIPSE_DOC_ID の値と同じである必要があります。
コピー後、ヘルプが表示される前に Eclipse を再起動する必要があります。
デフォルト値は: NO です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
ECLIPSE_DOC_ID Eclipse ヘルププラグインの一意の識別子です。プラグインをインストールする際、HTMLおよびXMLファイルを含むディレクトリ名もこの名前と同じである必要があります。各ドキュメンテーションセットは独自の識別子を持つべきです。
デフォルト値は org.doxygen.Project です。
このタグは、GENERATE_ECLIPSEHELP タグが YES に設定されている必要があります。
DISABLE_INDEX 生成されるHTMLページのレイアウトを完全に制御したい場合、インデックスを無効にして独自のインデックスに置き換える必要があるかもしれません。DISABLE_INDEX タグは、各HTMLページの上部にある凝縮されたインデックス（タブ）のオン/オフを切り替えるために使用できます。NO の値はインデックスを有効にし、YES の値は無効にします。インデックスのタブにはナビゲーションツリーと同じ情報が含まれているため、GENERATE_TREEVIEW も YES に設定した場合、このオプションを YES に設定できます。
デフォルト値は: NO です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
GENERATE_TREEVIEW GENERATE_TREEVIEW タグは、階層情報を表示するためにツリーのようなインデックス構造を生成するかどうかを指定するために使用されます。タグの値が YES に設定されている場合、ツリーのようなインデックス構造（HTMLヘルプ用に生成されるものとまったく同じ）を含むサイドパネルが生成されます。これが機能するには、JavaScript、DHTML、CSS、およびフレームをサポートするブラウザ（つまり、最新のブラウザ）が必要です。WindowsユーザーはHTMLヘルプ機能を使用した方が良いでしょう。
カスタムスタイルシート（HTML_EXTRA_STYLESHEET を参照）を介して、インデックスの見た目をさらに微調整できます（出力の微調整 を参照）。例として、Doxygen によって生成されるデフォルトのスタイルシートには、PROJECT_NAME の代わりにツリーのルートに画像を配置する方法を示す例があります。
ツリーは基本的にタブインデックスよりも詳細な情報を持っているため、このオプションを有効にする際には DISABLE_INDEX を YES に設定することを検討できます。
デフォルト値は: YES です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
PAGE_OUTLINE_PANEL GENERATE_TREEVIEW が YES に設定されている場合、PAGE_OUTLINE_PANEL オプションは、画面右側に、メインページの内容の概要を表示する追加のナビゲーションパネルを表示するかどうかを決定します。これは、例えば https://developer.android.com/reference のようなものです。
GENERATE_TREEVIEW が NO に設定されている場合、このオプションは効果がありません。
デフォルト値は: YES です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
FULL_SIDEBAR GENERATE_TREEVIEW が YES に設定されている場合、FULL_SIDEBAR オプションは、サイドバーがツリービュー領域のみに限定されるか（値 NO）、ウィンドウの全高に拡張されるか（値 YES）を決定します。これを YES に設定すると、たとえば https://docs.readthedocs.io のようなレイアウトになり、コンテンツのスペースが増えますが、プロジェクトのロゴ、タイトル、説明のスペースは減ります。
GENERATE_TREEVIEW が NO に設定されている場合、このオプションは効果がありません。
デフォルト値は: NO です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
ENUM_VALUES_PER_LINE ENUM_VALUES_PER_LINE タグは、Doxygen が生成されたHTMLドキュメントで1行にグループ化する列挙値の数を設定するのに使用できます。
値が0の場合、概要セクションに列挙値が完全に表示されなくなることに注意してください。
最小値: 0、最大値: 20、デフォルト値: 4。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
SHOW_ENUM_VALUES SHOW_ENUM_VALUES タグが設定されている場合、Doxygen は指定された列挙値を列挙ニーモニックの横に表示します。
デフォルト値は: NO です。
TREEVIEW_WIDTH ツリービューが有効になっている場合（GENERATE_TREEVIEW を参照）、このタグを使用して、ツリーが表示されるフレームの初期幅（ピクセル単位）を設定できます。
最小値: 0、最大値: 1500、デフォルト値: 250。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
EXT_LINKS_IN_WINDOW EXT_LINKS_IN_WINDOW オプションが YES に設定されている場合、Doxygen はタグファイルを介してインポートされた外部シンボルへのリンクを別のウィンドウで開きます。
デフォルト値は: NO です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
OBFUSCATE_EMAILS OBFUSCATE_EMAILS タグが YES に設定されている場合、Doxygen はメールアドレスを難読化します。
デフォルト値は: YES です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
HTML_FORMULA_FORMAT HTML_FORMULA_FORMAT オプションが svg に設定されている場合、Doxygen は pdf2svg ツール（https://github.com/dawbarton/pdf2svg を参照）または inkscape（https://inkscape.org を参照）を使用して、HTML出力用の数式をPNGではなくSVG画像として生成します。これらの画像は通常、拡大された解像度でよりきれいに見えます。
取りうる値は：png（デフォルト）と svg（見た目はより良いが、pdf2svg または inkscape ツールが必要）。
デフォルト値は png です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
FORMULA_FONTSIZE このタグを使用して、HTML ドキュメントに画像として含まれる 数式のフォントサイズを変更できます。Doxygen の実行が成功した後にフォントサイズを変更した場合、HTML 出力ディレクトリから form_*.png 画像を手動で削除して、強制的に再生成する必要があります。
最小値: 8、最大値: 50、デフォルト値: 10。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
FORMULA_MACROFILE FORMULA_MACROFILE は、数式で構成要素として使用される新しい コマンドを作成するための \newcommand および \renewcommand コマンドを含むことができます。詳細については、セクション Including formulas を参照してください。
USE_MATHJAX USE_MATHJAX オプションを有効にすると、 数式が MathJax（https://www.mathjax.org を参照）を使用してレンダリングされます。これは、事前にレンダリングされたビットマップを使用する代わりに、クライアント側のJavaScriptを使用してレンダリングを行います。これは、 がインストールされていない場合や、HTML出力で数式をよりきれいに表示したい場合に役立ちます。有効にした場合、MathJaxを個別にインストールし、MATHJAX_RELPATH オプションを使用してMathJaxへのパスを設定する必要がある場合もあります。
デフォルト値は: NO です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
MATHJAX_VERSION MATHJAX_VERSION を使用すると、使用するMathJaxのバージョンを指定できます。MathJaxのバージョンによって異なる設定要件があるため、MathJaxのバージョンを切り替える際に、他のMathJax設定も変更する必要がある場合があることに注意してください。
取りうる値は：MathJax_2 と MathJax_3 です。
デフォルト値は MathJax_2 です。
このタグは、USE_MATHJAX タグが YES に設定されている必要があります。
MATHJAX_FORMAT MathJax が有効になっている場合、MathJax の出力に使用されるデフォルトの出力形式を設定できます。出力形式の詳細については、MathJax バージョン 2 および MathJax バージョン 3 を参照してください。
取りうる値は: HTML-CSS (遅いが互換性が最も高い。これはMathJaxバージョン2の名前で、MathJaxバージョン3ではchtmlに変換される)、NativeMML (つまりMathML。MathJax 2のみサポート。MathJaxバージョン3では代わりにchtmlが使用される)、chtml (これはMathJaxバージョン3の名前で、MathJaxバージョン2ではHTML-CSSに変換される)、およびSVGです。
デフォルト値は HTML-CSS です。
このタグは、USE_MATHJAX タグが YES に設定されている必要があります。
MATHJAX_RELPATH MathJaxが有効になっている場合、MATHJAX_RELPATHオプションを使用してHTML出力ディレクトリからの相対位置を指定する必要があります。宛先ディレクトリにはMathJax.jsスクリプトが含まれている必要があります。例えば、mathjaxディレクトリがHTML出力ディレクトリと同じレベルにある場合、MATHJAX_RELPATHは../mathjaxであるべきです。デフォルト値はMathJax Content Delivery Networkを指しているため、MathJaxをインストールせずにすぐに結果を見ることができます。ただし、デプロイ前にhttps://www.mathjax.orgからMathJaxのローカルコピーをインストールすることを強くお勧めします。
デフォルト値は
このタグは、USE_MATHJAX タグが YES に設定されている必要があります。
MATHJAX_EXTENSIONS MATHJAX_EXTENSIONS タグは、MathJax レンダリング中に有効にすべき MathJax 拡張機能名を1つ以上指定するのに使用できます。例えば MathJax バージョン 2 の場合（https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions を参照）
MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
例えば MathJax バージョン 3 の場合（http://docs.mathjax.org/en/latest/input/tex/extensions/index.html を参照）
MATHJAX_EXTENSIONS = ams
このタグは、USE_MATHJAX タグが YES に設定されている必要があります。
MATHJAX_CODEFILE MATHJAX_CODEFILE タグは、MathJax コードの起動時に使用される JavaScript コードの断片を含むファイルを指定するのに使用できます。詳細については、MathJax サイト を参照してください。例として、MathJax の「Math Settings」メニューにある「Math Renderer」メニュー項目を無効にするには、
MATHJAX_CODEFILE = disableRenderer.js
ファイル disableRenderer.js の中身は
MathJax.Hub.Config({
menuSettings: {
showRenderer: false,
}
});
このタグは、USE_MATHJAX タグが YES に設定されている必要があります。
SEARCHENGINE SEARCHENGINE タグが有効になっている場合、DoxygenはHTML出力用に検索ボックスを生成します。基盤となる検索エンジンはJavaScriptとDHTMLを使用しており、最新のブラウザであれば動作するはずです。HTMLヘルプ（GENERATE_HTMLHELP）、Qtヘルプ（GENERATE_QHP）、またはドキュメントセット（GENERATE_DOCSET）を使用している場合はすでに検索機能があるため、通常これは無効にするべきです。大規模なプロジェクトの場合、JavaScriptベースの検索エンジンは遅くなる可能性があるため、SERVER_BASED_SEARCH を有効にするとより良い解決策となる場合があります。
キーボードを使用して検索することも可能です。検索ボックスにジャンプするには <access key> + S を使用します（<access key> はOSとブラウザによって異なりますが、通常は <CTRL>、<ALT>/<option>、またはその両方です）。検索ボックス内で <cursor down key> を使用して検索結果ウィンドウにジャンプし、<cursor keys> を使用して結果をナビゲートできます。項目を選択するには <Enter> を押し、検索をキャンセルするには <escape> を押します。フィルタオプションは、カーソルが検索ボックス内にあるときに <Shift>+<cursor down> を押して選択できます。ここでも <cursor keys> を使用してフィルタを選択し、<Enter> または <escape> を押してフィルタオプションをアクティブ化またはキャンセルします。
デフォルト値は: YES です。
このタグは、GENERATE_HTML タグが YES に設定されている必要があります。
SERVER_BASED_SEARCH SERVER_BASED_SEARCH タグが有効になっている場合、検索エンジンはJavaScriptを使用するウェブクライアントではなく、ウェブサーバーを使用して実装されます。
ウェブサーバーベースの検索には、EXTERNAL_SEARCH の設定に応じて2つの種類があります。無効になっている場合、Doxygen は検索用のPHPスクリプトと、そのスクリプトで使用されるインデックスファイルを生成します。EXTERNAL_SEARCH が有効になっている場合、インデックス作成と検索は外部ツールによって提供される必要があります。詳細については、「External Indexing and Searching」セクションを参照してください。
デフォルト値は: NO です。
このタグは、SEARCHENGINE タグが YES に設定されている必要があります。
EXTERNAL_SEARCH EXTERNAL_SEARCH タグが有効になっている場合、Doxygen は検索用のPHPスクリプトを生成しなくなります。代わりに、検索結果はXMLファイルに書き込まれ、外部のインデクサーによって処理される必要があります。Doxygen は、SEARCHENGINE_URL オプションによって指定された外部検索エンジンを呼び出し、検索結果を取得します。
Doxygenは、オープンソースの検索エンジンライブラリXapianに基づいた、サンプルのインデクサー（doxyindexer）と検索エンジン（doxysearch.cgi）を同梱しています。
詳細については、セクション External Indexing and Searching を参照してください。
デフォルト値は: NO です。
このタグは、SEARCHENGINE タグが YES に設定されている必要があります。
SEARCHENGINE_URL SEARCHENGINE_URL は、ウェブサーバーがホストする検索エンジンを指す必要があります。この検索エンジンは、EXTERNAL_SEARCH が有効になっているときに検索結果を返します。
Doxygenは、オープンソースの検索エンジンライブラリXapianに基づいた、サンプルのインデクサー（doxyindexer）と検索エンジン（doxysearch.cgi）を同梱しています。詳細については、セクションExternal Indexing and Searchingを参照してください。
このタグは、SEARCHENGINE タグが YES に設定されている必要があります。
SEARCHDATA_FILE SERVER_BASED_SEARCH と EXTERNAL_SEARCH の両方が有効になっている場合、インデックス化されていない検索データは、外部ツールによるインデックス化のためにファイルに書き込まれます。SEARCHDATA_FILE タグを使用すると、このファイルの名前を指定できます。
デフォルトファイルは searchdata.xml です。
このタグは、SEARCHENGINE タグが YES に設定されている必要があります。
EXTERNAL_SEARCH_ID SERVER_BASED_SEARCH と EXTERNAL_SEARCH の両方が有効になっている場合、EXTERNAL_SEARCH_ID タグはプロジェクトの識別子として使用できます。これは、EXTRA_SEARCH_MAPPINGS と組み合わせて、複数のプロジェクトを検索し、結果を正しいプロジェクトにリダイレクトする場合に役立ちます。
このタグは、SEARCHENGINE タグが YES に設定されている必要があります。
EXTRA_SEARCH_MAPPINGS EXTRA_SEARCH_MAPPINGS タグは、この設定ファイルで定義されたもの以外のDoxygenプロジェクトで検索を有効にするために使用できますが、それらはすべて同じ外部検索インデックスに追加されます。各プロジェクトは、EXTERNAL_SEARCH_ID を介して一意のIDを持つ必要があります。検索マッピングは、IDをドキュメントが見つかる相対位置にマップします。
形式は
EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
このタグは、SEARCHENGINE タグが YES に設定されている必要があります。
GENERATE_LATEX GENERATE_LATEX タグが YES に設定されている場合、Doxygen は 出力を生成します。
デフォルト値は: YES です。
LATEX_OUTPUT LATEX_OUTPUT タグは、 ドキュメントの出力先を指定するために使用されます。相対パスが入力された場合、OUTPUT_DIRECTORY の値がその前に置かれます。
デフォルトのディレクトリは latex です。
このタグは、GENERATE_LATEX タグが YES に設定されている必要があります。
LATEX_CMD_NAME LATEX_CMD_NAME タグは、呼び出す コマンド名を指定するために使用できます。
注記: USE_PDFLATEX を有効にしていない場合、デフォルトは latex であり、USE_PDFLATEX を有効にしている場合、デフォルトは pdflatex です。後者の場合で latex が選択されている場合でも、pdflatex によって上書きされます。特定の出力言語では、デフォルトが異なる設定になっていることがあり、これは出力言語の実装に依存します。
このタグは、GENERATE_LATEX タグが YES に設定されている必要があります。
MAKEINDEX_CMD_NAME MAKEINDEX_CMD_NAME タグは、 用の索引を生成するコマンド名を指定するために使用できます。
デフォルトのファイルは makeindex です。
このタグは、GENERATE_LATEX タグが YES に設定されている必要があります。
LATEX_MAKEINDEX_CMD LATEX_MAKEINDEX_CMD タグは、 用の索引を生成するコマンド名を指定するために使用できます。最初の文字がバックスラッシュ (\) でない場合、 コードに自動的に追加されます。
デフォルト値は makeindex です。
このタグは、GENERATE_LATEX タグが YES に設定されている必要があります。
COMPACT_LATEX COMPACT_LATEX タグが YES に設定されている場合、Doxygen はよりコンパクトな ドキュメントを生成します。これは小規模なプロジェクトに役立ち、一般的にいくつかの木を節約するのに役立つかもしれません。
デフォルト値は: NO です。
このタグは、GENERATE_LATEX タグが YES に設定されている必要があります。
PAPER_TYPE PAPER_TYPE タグは、プリンターが使用する用紙の種類を設定するために使用できます。
指定可能な値は、a4 (210 x 297 mm)、letter (8.5 x 11 インチ)、legal (8.5 x 14 インチ)、および executive (7.25 x 10.5 インチ) です。
デフォルト値は a4 です。
このタグは、GENERATE_LATEX タグが YES に設定されている必要があります。
EXTRA_PACKAGES EXTRA_PACKAGES タグは、 出力に含めるべき1つ以上の パッケージ名を指定するために使用できます。パッケージは、その名前だけで指定することも、 の \usepackage コマンドで使用する正しい構文で指定することもできます。
例えば、times フォントを使用するには、次のように指定します。
EXTRA_PACKAGES=times
or
EXTRA_PACKAGES={times}
amsmath パッケージでオプション intlimits を使用するには、次のように指定します。
EXTRA_PACKAGES=[intlimits]{amsmath}
空白のままにした場合、追加のパッケージは含まれません。
このタグは、GENERATE_LATEX タグが YES に設定されている必要があります。
LATEX_HEADER LATEX_HEADER タグは、生成される ドキュメントのユーザー定義 ヘッダーを指定するために使用できます。ヘッダーは、最初の章までのすべてを含む必要があります。空白のままにした場合、Doxygen は標準のヘッダーを生成します。
デフォルトのヘッダーを使用することから始めることを強くお勧めします。
doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
その後、ファイル new_header.tex を修正します。
Doxygenが通常使用するデフォルトのヘッダーを生成する方法については、セクションDoxygen usageも参照してください。
注記: ユーザー定義ヘッダーは、ご自身で内容を理解している場合にのみ使用してください！
$title$datetime$date$time$year$showdate(<format>)$doxygenversion$projectname$projectnumber$projectbrief$projectlogo$latexdocumentpre$latexdocumentpost$generatedby$latexcitereference$latexbibstyle bib スタイルに置き換えられます。何も設定されていない場合、bib スタイル plain が使用されます。この設定は、通常、ブロック名 CITATIONS_PRESENT と組み合わせて使用されます。$latexbibfiles$papertype 用紙の種類になります。$langISO$languagesupport$latexfontenc$latexfont$latexemojidirectory で使用可能になります）。LATEX_EMOJI_DIRECTORY が空の場合、現在のディレクトリが使用されます。$makeindex$extralatexpackages$extralatexstylesheet$latexspecialformulachars$formulamacrofile設定によってヘッダーとフッターのレイアウトに違いがある場合に対応するため、ヘッダーとフッターには、設定に応じて出力にコピーされるかスキップされる特別なブロックを含めることもできます。そのようなブロックは以下の形式を持ちます。
%%BEGIN BLOCKNAME Some context copied when condition BLOCKNAME holds %%END BLOCKNAME %%BEGIN !BLOCKNAME Some context copied when condition BLOCKNAME does not hold %%END !BLOCKNAME
以下のブロック名は、設定ファイルで使用される設定に基づいて設定されます。
COMPACT_LATEXPDF_HYPERLINKSUSE_PDFLATEXLATEX_BATCHMODETIMESTAMP以下のブロック名は、使用される設定ファイルにそのタグの値があるかどうかに基づいて設定されます。
LATEX_FONTENC 翻訳関数が使用するフォントエンコーディングの値を返す場合、このブロック内のコンテンツは出力にコピーされます。これは、前述の $latexfontenc と組み合わせて使用されます。FORMULA_MACROFILE以下のブロック名は、ドキュメントで機能が使用されているかどうかに基づいて設定されます。
CITATIONS_PRESENTこのタグは、GENERATE_LATEX タグが YES に設定されている必要があります。
LATEX_FOOTER LATEX_FOOTER タグは、生成される ドキュメントのユーザー定義 フッターを指定するために使用できます。フッターは、最後の章以降のすべてを含む必要があります。空白のままにした場合、Doxygen は標準のフッターを生成します。
デフォルトのフッターを生成する方法や、フッター内で使用できる特殊なコマンドの詳細については、LATEX_HEADER を参照してください。
Doxygenが通常使用するデフォルトのフッターを生成する方法については、セクションDoxygen usageも参照してください。
注記: ユーザー定義フッターは、ご自身で内容を理解している場合にのみ使用してください！
このタグは、GENERATE_LATEX タグが YES に設定されている必要があります。
LATEX_EXTRA_STYLESHEET LATEX_EXTRA_STYLESHEET タグは、Doxygen が作成する標準スタイルシートの後に含める追加のユーザー定義 スタイルシートを指定するために使用できます。このオプションを使用すると、特定のスタイル要素を上書きできます。Doxygen はスタイルシートファイルをその出力ディレクトリにコピーします。YES に設定されている必要があります。LATEX_EXTRA_FILES LATEX_EXTRA_FILES タグは、LATEX_OUTPUT 出力ディレクトリにコピーされるべき1つ以上の追加画像ファイルまたはその他のソースファイルを指定するために使用できます。ファイルはそのままコピーされ、コマンドやマーカーは利用できないことに注意してください。
このタグは、GENERATE_LATEX タグが YES に設定されている必要があります。
PDF_HYPERLINKS PDF_HYPERLINKS タグが YES に設定されている場合、生成される は PDF への変換（ps2pdf または pdflatex を使用）のために準備されます。PDF ファイルには、ページ参照ではなく（HTML 出力と同様に）リンクが含まれます。これにより、出力は PDF ビューアを使用したオンライン閲覧に適したものになります。
デフォルト値は: YES です。
このタグは、GENERATE_LATEX タグが YES に設定されている必要があります。
USE_PDFLATEX USE_PDFLATEX タグが YES に設定されている場合、Doxygen は LATEX_CMD_NAME で指定されたエンジンを使用して、 ファイルから直接 PDF ファイルを生成します。より高品質の PDF ドキュメントを得るには、このオプションを YES に設定してください。
エンジンの選択については、LATEX_CMD_NAME のセクションも参照してください。
デフォルト値は: YES です。
このタグは、GENERATE_LATEX タグが YES に設定されている必要があります。
LATEX_BATCHMODE LATEX_BATCHMODE タグは、エラー発生時の の動作を示します。
指定可能な値は次のとおりです: NO は ERROR_STOP と同じ、YES は BATCH と同じ、BATCH バッチモードではターミナルに何も表示されず、エラーはまるでエラーごとに <return> が押されたかのようにスクロールされます。TeX が入力しようとするファイルが見つからない場合、またはキーボード入力が要求された場合（開いていない入力ストリームでの \read）、ジョブは中断されます。NON_STOP ノンストップモードでは、診断メッセージがターミナルに表示されますが、バッチモードと同様にユーザーとのインタラクションの可能性はありません。SCROLL スクロールモードでは、TeX はファイル入力が見つからない場合、またはキーボード入力が必要な場合にのみ停止します。ERROR_STOP エラーストップモードでは、TeX は各エラーで停止し、ユーザーの介入を求めます。
デフォルト値は: NO です。
このタグは、GENERATE_LATEX タグが YES に設定されている必要があります。
LATEX_HIDE_INDICES LATEX_HIDE_INDICES タグが YES に設定されている場合、Doxygen は索引章（ファイル索引、複合索引など）を出力に含めません。
デフォルト値は: NO です。
このタグは、GENERATE_LATEX タグが YES に設定されている必要があります。
LATEX_BIB_STYLE LATEX_BIB_STYLE タグは、参考文献に使用するスタイル（例：plainnat または ieeetr）を指定するために使用できます。詳細については、https://en.wikipedia.org/wiki/BibTeX および \cite を参照してください。
デフォルト値は plainnat です。
このタグは、GENERATE_LATEX タグが YES に設定されている必要があります。
LATEX_EMOJI_DIRECTORY LATEX_EMOJI_DIRECTORY タグは、絵文字画像が読み込まれる（相対または絶対）パスを指定するために使用されます。相対パスが入力された場合、それは LATEX_OUTPUT ディレクトリからの相対パスとなります。空白のままにした場合、LATEX_OUTPUT ディレクトリが使用されます。
このタグは、GENERATE_LATEX タグが YES に設定されている必要があります。
GENERATE_RTF GENERATE_RTF タグが YES に設定されている場合、Doxygen は RTF 出力を生成します。RTF 出力は Word 97 向けに最適化されており、他の RTF リーダー/エディターではあまりきれいに表示されない場合があります。
デフォルト値は: NO です。
RTF_OUTPUT RTF_OUTPUT タグは、RTF ドキュメントが配置される場所を指定するために使用されます。相対パスが入力された場合、OUTPUT_DIRECTORY の値がその前に付けられます。
デフォルトディレクトリは rtf です。
このタグは、GENERATE_RTF タグが YES に設定されている必要があります。
COMPACT_RTF COMPACT_RTF タグが YES に設定されている場合、Doxygen はよりコンパクトな RTF ドキュメントを生成します。これは小規模なプロジェクトに役立ち、一般的にいくつかの木を節約するのに役立つかもしれません。
デフォルト値は: NO です。
このタグは、GENERATE_RTF タグが YES に設定されている必要があります。
RTF_HYPERLINKS RTF_HYPERLINKS タグが YES に設定されている場合、生成される RTF にはハイパーリンクフィールドが含まれます。RTF ファイルには、ページ参照ではなく（HTML 出力と同様に）リンクが含まれます。これにより、出力は Word またはそのようなフィールドをサポートする他の Word 互換リーダーを使用したオンライン閲覧に適したものになります。
注記: WordPad（書き込み）などはリンクをサポートしていません。
デフォルト値は: NO です。
このタグは、GENERATE_RTF タグが YES に設定されている必要があります。
RTF_STYLESHEET_FILE スタイルシートの定義をファイルから読み込みます。構文は Doxygen の設定ファイルに似ており、一連の割り当てです。置き換えのみを提供すればよく、不足している定義はデフォルト値に設定されます。
Doxygen が通常使用するデフォルトスタイルシートの生成方法については、Doxygen usage のセクションも参照してください。
このタグは、GENERATE_RTF タグが YES に設定されている必要があります。
RTF_EXTENSIONS_FILE RTF ドキュメントの生成で使用されるオプション変数を設定します。構文は Doxygen の設定ファイルに似ています。テンプレート拡張ファイルは、doxygen -e rtf extensionFile を使用して生成できます。
このタグは、GENERATE_RTF タグが YES に設定されている必要があります。
RTF_EXTRA_FILES RTF_EXTRA_FILES タグは、RTF_OUTPUT 出力ディレクトリにコピーされるべき1つ以上の追加画像ファイルまたはその他のソースファイルを指定するために使用できます。ファイルはそのままコピーされ、コマンドやマーカーは利用できないことに注意してください。
このタグは、GENERATE_RTF タグが YES に設定されている必要があります。
GENERATE_MAN GENERATE_MAN タグが YES に設定されている場合、Doxygen はクラスおよびファイル用の man ページを生成します。
デフォルト値は: NO です。
MAN_OUTPUT MAN_OUTPUT タグは、man ページが配置される場所を指定するために使用されます。相対パスが入力された場合、OUTPUT_DIRECTORY の値がその前に付けられます。MAN_OUTPUT で指定されたディレクトリ内に man3 ディレクトリが作成されます。
デフォルトディレクトリは man です。
このタグは、GENERATE_MAN タグが YES に設定されている必要があります。
MAN_EXTENSION MAN_EXTENSION タグは、生成される man ページに追加される拡張子を決定します。マニュアルセクションが数字で始まらない場合、数字 3 が前置されます。MAN_EXTENSION タグの先頭のドット (.) はオプションです。
デフォルト値は .3 です。
このタグは、GENERATE_MAN タグが YES に設定されている必要があります。
MAN_SUBDIR MAN_SUBDIR タグは、MAN_OUTPUT 内に作成され man ページが配置されるディレクトリの名前を決定します。デフォルトは、先頭のドットが削除された MAN_EXTENSION に続く man です。
このタグは、GENERATE_MAN タグが YES に設定されている必要があります。
MAN_LINKS MAN_LINKS タグが YES に設定されており、Doxygen が man 出力を生成する場合、実際の man ページに記述されている各エンティティに対して追加の man ファイルが1つ生成されます。これらの追加ファイルは実際の man ページをソースとしていますが、これらがないと man コマンドは正しいページを見つけることができません。
デフォルト値は: NO です。
このタグは、GENERATE_MAN タグが YES に設定されている必要があります。
GENERATE_XML GENERATE_XML タグが YES に設定されている場合、Doxygen はすべてのドキュメントを含むコードの構造をキャプチャする XML ファイルを生成します。
デフォルト値は: NO です。
XML_OUTPUT XML_OUTPUT タグは、XML ページが配置される場所を指定するために使用されます。相対パスが入力された場合、OUTPUT_DIRECTORY の値がその前に付けられます。
デフォルトディレクトリは xml です。
このタグは、GENERATE_XML タグが YES に設定されている必要があります。
XML_PROGRAMLISTING XML_PROGRAMLISTING タグが YES に設定されている場合、Doxygen はプログラムリスト（構文ハイライトと相互参照情報を含む）を XML 出力にダンプします。これを有効にすると、XML 出力のサイズが大幅に増加することに注意してください。
デフォルト値は: YES です。
このタグは、GENERATE_XML タグが YES に設定されている必要があります。
XML_NS_MEMB_FILE_SCOPE XML_NS_MEMB_FILE_SCOPE タグが YES に設定されている場合、Doxygen は名前空間メンバーをファイルスコープにも含め、HTML 出力と一致させます。
デフォルト値は: NO です。
このタグは、GENERATE_XML タグが YES に設定されている必要があります。
GENERATE_DOCBOOK GENERATE_DOCBOOK タグが YES に設定されている場合、Doxygen は PDF の生成に使用できる Docbook ファイルを生成します。
デフォルト値は: NO です。
DOCBOOK_OUTPUT DOCBOOK_OUTPUT タグは、Docbook ページが配置される場所を指定するために使用されます。相対パスが入力された場合、OUTPUT_DIRECTORY の値がその前に付けられます。
デフォルトディレクトリは docbook です。
このタグは、GENERATE_DOCBOOK タグが YES に設定されている必要があります。
GENERATE_AUTOGEN_DEF GENERATE_AUTOGEN_DEF タグが YES に設定されている場合、Doxygen は、すべてのドキュメントを含むコードの構造をキャプチャする AutoGen 定義（https://autogen.sourceforge.net/ を参照）ファイルを生成します。この機能は現在も実験的であり、不完全であることに注意してください。
デフォルト値は: NO です。
GENERATE_SQLITE3 GENERATE_SQLITE3 タグが YES に設定されている場合、Doxygen は Doxygen によって見つかったシンボルをテーブルに格納した Sqlite3 データベースを生成します。
デフォルト値は: NO です。
SQLITE3_OUTPUT SQLITE3_OUTPUT タグは、Sqlite3 データベースが配置される場所を指定するために使用されます。相対パスが入力された場合、OUTPUT_DIRECTORY の値がその前に付けられます。
デフォルトディレクトリは sqlite3 です。
このタグは、GENERATE_SQLITE3 タグが YES に設定されている必要があります。
SQLITE3_RECREATE_DB SQLITE3_RECREATE_DB タグが YES に設定されている場合、既存の doxygen_sqlite3.db データベースファイルは Doxygen を実行するたびに再作成されます。NO に設定されている場合、Doxygen はデータベースファイルが既に存在する場合は警告を発し、それを変更しません。
デフォルト値は: YES です。
このタグは、GENERATE_SQLITE3 タグが YES に設定されている必要があります。
GENERATE_PERLMOD GENERATE_PERLMOD タグが YES に設定されている場合、Doxygen はすべてのドキュメントを含むコードの構造をキャプチャする Perl モジュールファイルを生成します。
この機能は現在も実験的であり、不完全であることに注意してください。
デフォルト値は: NO です。
PERLMOD_LATEX PERLMOD_LATEX タグが YES に設定されている場合、Doxygen は Perl モジュール出力から PDF および DVI 出力を生成するために必要な Makefile ルール、Perl スクリプト、および コードを生成します。
デフォルト値は: NO です。
このタグは、GENERATE_PERLMOD タグが YES に設定されている必要があります。
PERLMOD_PRETTY PERLMOD_PRETTY タグが YES に設定されている場合、Perl モジュール出力は人間が読みやすいようにきれいにフォーマットされます。これは、何が起こっているかを理解したい場合に役立ちます。一方、このタグが NO に設定されている場合、Perl モジュール出力のサイズははるかに小さくなり、Perl は同じように解析します。
デフォルト値は: YES です。
このタグは、GENERATE_PERLMOD タグが YES に設定されている必要があります。
PERLMOD_MAKEVAR_PREFIX 生成される doxyrules.make ファイル内の make 変数の名前は、PERLMOD_MAKEVAR_PREFIX に含まれる文字列でプレフィックスが付けられます。これは、同じ Makefile によってインクルードされる異なる doxyrules.make ファイルが互いの変数を上書きしないようにするのに役立ちます。
このタグは、GENERATE_PERLMOD タグが YES に設定されている必要があります。
ENABLE_PREPROCESSING ENABLE_PREPROCESSING タグが YES に設定されている場合、Doxygen はソースおよびインクルードファイル内で見つかったすべての C-プリプロセッサディレクティブを評価します。
デフォルト値は: YES です。
MACRO_EXPANSION MACRO_EXPANSION タグが YES に設定されている場合、Doxygen はソースコード内のすべてのマクロ名を展開します。NO に設定されている場合、条件付きコンパイルのみが実行されます。マクロ展開は、EXPAND_ONLY_PREDEF を YES に設定することで制御された方法で行うことができます。
デフォルト値は: NO です。
このタグは、ENABLE_PREPROCESSING タグが YES に設定されている必要があります。
EXPAND_ONLY_PREDEF EXPAND_ONLY_PREDEF と MACRO_EXPANSION の両方のタグが YES に設定されている場合、マクロ展開は PREDEFINED および EXPAND_AS_DEFINED タグで指定されたマクロに限定されます。
デフォルト値は: NO です。
このタグは、ENABLE_PREPROCESSING タグが YES に設定されている必要があります。
SEARCH_INCLUDES SEARCH_INCLUDES タグが YES に設定されている場合、#include が見つかると INCLUDE_PATH 内のインクルードファイルが検索されます。
デフォルト値は: YES です。
このタグは、ENABLE_PREPROCESSING タグが YES に設定されている必要があります。
INCLUDE_PATH INCLUDE_PATH タグは、入力ファイルではないがプリプロセッサによって処理されるべきインクルードファイルを含む1つ以上のディレクトリを指定するために使用できます。
INCLUDE_PATH は再帰的ではないため、RECURSIVE の設定はここでは効果がないことに注意してください。
このタグは、SEARCH_INCLUDES タグが YES に設定されている必要があります。
INCLUDE_FILE_PATTERNS INCLUDE_FILE_PATTERNS タグを使用して、ディレクトリ内のヘッダーファイルをフィルタリングするために、1つ以上のワイルドカードパターン（例：*.h や *.hpp）を指定できます。空白のままにした場合、FILE_PATTERNS で指定されたパターンが使用されます。
このタグは、ENABLE_PREPROCESSING タグが YES に設定されている必要があります。
PREDEFINED PREDEFINED タグは、プリプロセッサが開始される前に定義される1つ以上のマクロ名を指定するために使用できます（例: gcc の -D オプションに類似）。タグの引数は、name または name=definition（スペースなし）の形式のマクロリストです。定義と "=" が省略された場合、"=1" とみなされます。マクロ定義が #undef によって未定義になったり、再帰的に展開されたりするのを防ぐには、= 演算子の代わりに := 演算子を使用します。
このタグは、ENABLE_PREPROCESSING タグが YES に設定されている必要があります。
EXPAND_AS_DEFINED MACRO_EXPANSION と EXPAND_ONLY_PREDEF タグが YES に設定されている場合、このタグを使用して展開すべきマクロ名のリストを指定できます。ソース内で見つかったマクロ定義が使用されます。ソースコード内で見つかった定義を上書きする別のマクロ定義を使用したい場合は、PREDEFINED タグを使用してください。
このタグは、ENABLE_PREPROCESSING タグが YES に設定されている必要があります。
SKIP_FUNCTION_MACROS SKIP_FUNCTION_MACROS タグが YES に設定されている場合、Doxygen のプリプロセッサは、行単独で存在し、すべて大文字の名前を持ち、セミコロンで終わらない関数のようなマクロへのすべての参照を削除します。そのような関数マクロは通常、ボイラープレートコードに使用され、削除しないとパーサーを混乱させます。
デフォルト値は: YES です。
このタグは、ENABLE_PREPROCESSING タグが YES に設定されている必要があります。
TAGFILES TAGFILES タグは、1つ以上のタグファイルを指定するために使用できます。
各タグファイルには、外部ドキュメントの場所を追加する必要があります。この場所がないタグファイルの形式は以下のとおりです。
TAGFILES = file1 file2 ...
タグファイルの場所を追加する方法は以下のとおりです。
TAGFILES = file1=loc1 "file2 = loc2" ...
ここで loc1 と loc2 は相対パス、絶対パス、または URL のいずれかです。タグファイルの使用に関する詳細については、外部ドキュメントへのリンク のセクションを参照してください。
GENERATE_TAGFILE GENERATE_TAGFILE の後にファイル名が指定された場合、Doxygen は読み込む入力ファイルに基づいてタグファイルを作成します。タグファイルの使用方法に関する詳細については、外部ドキュメントへのリンク のセクションを参照してください。
ALLEXTERNALS ALLEXTERNALS タグが YES に設定されている場合、すべての外部クラスと名前空間がクラスおよび名前空間の索引にリストされます。NO に設定されている場合、継承された外部クラスのみがリストされます。
デフォルト値は: NO です。
EXTERNAL_GROUPS EXTERNAL_GROUPS タグが YES に設定されている場合、すべての外部グループがトピック索引にリストされます。NO に設定されている場合、現在のプロジェクトのグループのみがリストされます。
デフォルト値は: YES です。
EXTERNAL_PAGES EXTERNAL_PAGES タグが YES に設定されている場合、すべての外部ページが関連ページ索引にリストされます。NO に設定されている場合、現在のプロジェクトのページのみがリストされます。
デフォルト値は: YES です。
HIDE_UNDOC_RELATIONS YES に設定されている場合、継承グラフとコラボレーショングラフは、ターゲットがドキュメント化されていないかクラスではない場合に、継承および使用関係を非表示にします。
デフォルト値は: YES です。
HAVE_DOT HAVE_DOT タグを YES に設定すると、Doxygen は dot ツールが path から利用可能であると仮定します。このツールは、AT&T と Lucent Bell Labs のグラフ可視化ツールキットである Graphviz の一部です。このオプションが NO に設定されている場合、このセクションの他のオプションは効果がありません。
デフォルト値は: NO です。
DOT_NUM_THREADS DOT_NUM_THREADS は、Doxygen が並行して実行できる dot の呼び出し数を指定します。0 に設定すると、Doxygen はシステムの利用可能なプロセッサ数に基づいてこれを決定します。CPU 負荷と処理速度のバランスを制御するために、明示的に 0 より大きい値を設定できます。
最小値: 0、最大値: 32、デフォルト値: 0。
このタグは、HAVE_DOT タグが YES に設定されている必要があります。
DOT_COMMON_ATTR DOT_COMMON_ATTR は、ノード、エッジ、およびサブグラフのラベルに共通の属性です。Doxygen が生成する dot ファイルで異なるフォントを使用したい場合、fontname、fontcolor、および fontsize 属性を指定できます。詳細については、Node, Edge and Graph Attributes specification を参照してください。dot がフォントを見つけられるように、標準の場所に配置するか、DOTFONTPATH 環境変数を設定するか、DOT_FONTPATH をフォントを含むディレクトリに設定することで、確認する必要があります。Graphviz のデフォルトのフォントサイズは 14 です。
デフォルト値は fontname=Helvetica,fontsize=10 です。
このタグは、HAVE_DOT タグが YES に設定されている必要があります。
DOT_EDGE_ATTR DOT_EDGE_ATTR は DOT_COMMON_ATTR と連結されます。エレガントなスタイルにするには、「arrowhead=open, arrowtail=open, arrowsize=0.5」を追加できます。矢印の形状に関する完全なドキュメント。
デフォルト値は labelfontname=Helvetica,labelfontsize=10 です。
このタグは、HAVE_DOT タグが YES に設定されている必要があります。
DOT_NODE_ATTR DOT_NODE_ATTR は DOT_COMMON_ATTR と連結されます。ノードの周りにボックスがないビューにするには、「shape=plain」または「shape=plaintext」を設定してください。形状仕様
デフォルト値は shape=box,height=0.2,width=0.4 です。
このタグは、HAVE_DOT タグが YES に設定されている必要があります。
DOT_FONTPATH dot が DOT_COMMON_ATTR およびその他の dot 属性で fontname に指定されたフォントを見つけられるパスを設定できます。
このタグは、HAVE_DOT タグが YES に設定されている必要があります。
CLASS_GRAPH CLASS_GRAPH タグが YES、GRAPH、または BUILTIN に設定されている場合、Doxygen は各ドキュメント化されたクラスについて、直接的および間接的な継承関係を示すグラフを生成します。CLASS_GRAPH タグが YES または GRAPH に設定されており、かつ HAVE_DOT も有効になっている場合、グラフの描画には dot が使用されます。CLASS_GRAPH タグが YES に設定されており、かつ HAVE_DOT が無効になっている場合、または CLASS_GRAPH タグが BUILTIN に設定されている場合、組み込みジェネレーターが使用されます。CLASS_GRAPH タグが TEXT に設定されている場合、直接的および間接的な継承関係はテキスト/リンクとして表示されます。特定のクラスの継承グラフを明示的に有効にするか、異なる表現を選択するには、\inheritancegraph コマンドを使用できます。継承グラフを無効にするには、\hideinheritancegraph コマンドを使用できます。
指定可能な値は、NO、YES、TEXT、GRAPH、および BUILTIN です。
デフォルト値は: YES です。
COLLABORATION_GRAPH COLLABORATION_GRAPHタグがYESに設定されている場合、Doxygenは各ドキュメント化されたクラスに対して、他のドキュメント化されたクラスとの直接的および間接的な実装依存関係（継承、集約、クラス参照変数）を示すグラフを生成します。COLLABORATION_GRAPHがNOに設定されている場合に、コラボレーショングラフを明示的に有効にするには、\collaborationgraphコマンドを使用します。コラボレーショングラフを無効にするには、\hidecollaborationgraphコマンドを使用します。
デフォルト値は: YES です。
このタグは、HAVE_DOTタグがYESに設定されている必要があります。
GROUP_GRAPHS GROUP_GRAPHSタグがYESに設定されている場合、Doxygenはグループのグラフを生成し、直接的なグループ依存関係を表示します。GROUP_GRAPHSがNOに設定されている場合に、グループ依存グラフを明示的に有効にするには、\groupgraphコマンドを使用します。ディレクトリグラフを無効にするには、\hidegroupgraphコマンドを使用します。
マニュアルのグループ化の章も参照してください。
デフォルト値は: YES です。
このタグは、HAVE_DOTタグがYESに設定されている必要があります。
UML_LOOK UML_LOOKタグがYESに設定されている場合、DoxygenはOMGの統一モデリング言語に似たスタイルで継承図とコラボレーション図を生成します。
デフォルト値は: NO です。
このタグは、HAVE_DOTタグがYESに設定されている必要があります。
UML_LIMIT_NUM_FIELDS UML_LOOKタグが有効になっている場合、フィールドとメソッドはクラスノード内に表示されます。多くのフィールドやメソッド、そして多くのノードがある場合、グラフが大きくなりすぎて使い物にならなくなる可能性があります。UML_LIMIT_NUM_FIELDSしきい値は、各タイプの項目数を制限し、サイズを管理しやすくします。制限なしにするには、これを0に設定してください。しきい値が適用される前に、しきい値が50%超える可能性があることに注意してください。したがって、しきい値を10に設定した場合、最大15のフィールドが表示されることがありますが、数が15を超えると、表示されるフィールドの総数は10に制限されます。
最小値: 0、最大値: 100、デフォルト値: 10。
このタグは、UML_LOOKタグがYESに設定されている必要があります。
UML_MAX_EDGE_LABELS UML_LOOKタグが有効になっている場合、フィールドラベルは2つのクラスノード間のエッジに沿って表示されます。多くのフィールドと多くのノードがある場合、グラフが乱雑になりすぎる可能性があります。UML_MAX_EDGE_LABELSしきい値は、項目数を制限し、サイズを管理しやすくします。制限なしにするには、これを0に設定してください。
最小値: 0、最大値: 100、デフォルト値: 10。
このタグは、UML_LOOKタグがYESに設定されている必要があります。
DOT_UML_DETAILS DOT_UML_DETAILSタグがNOに設定されている場合、DoxygenはUMLグラフにおいて、型と引数のない属性とメソッドを表示します。DOT_UML_DETAILSタグがYESに設定されている場合、DoxygenはUMLグラフにおいて、属性とメソッドに型と引数を追加します。DOT_UML_DETAILSタグがNONEに設定されている場合、DoxygenはUMLグラフにクラスメンバー情報を含むフィールドを生成しません。クラス図はデフォルトのクラス図に似ていますが、関係にUML表記を使用します。
設定可能な値は: NO、YES、NONEです。
デフォルト値は: NO です。
このタグは、UML_LOOKタグがYESに設定されている必要があります。
DOT_WRAP_THRESHOLD DOT_WRAP_THRESHOLDタグは、1行に表示する最大文字数を設定するために使用できます。実際の行長がこのしきい値を大幅に超えると、複数行にわたって折り返されます。見苦しい改行を避けるために、いくつかのヒューリスティックが適用されます。
最小値: 0、最大値: 1000、デフォルト値: 17。
このタグは、HAVE_DOTタグがYESに設定されている必要があります。
TEMPLATE_RELATIONS TEMPLATE_RELATIONSタグがYESに設定されている場合、継承グラフとコラボレーショングラフはテンプレートとそのインスタンス間の関係を表示します。
デフォルト値は: NO です。
このタグは、HAVE_DOTタグがYESに設定されている必要があります。
INCLUDE_GRAPH INCLUDE_GRAPH、ENABLE_PREPROCESSING、およびSEARCH_INCLUDESタグがYESに設定されている場合、Doxygenは各ドキュメント化されたファイルに対して、他のドキュメント化されたファイルとの直接的および間接的なインクルード依存関係を示すグラフを生成します。INCLUDE_GRAPHがNOに設定されている場合に、インクルードグラフを明示的に有効にするには、\includegraphコマンドを使用します。インクルードグラフを無効にするには、\hideincludegraphコマンドを使用します。
デフォルト値は: YES です。
このタグは、HAVE_DOTタグがYESに設定されている必要があります。
INCLUDED_BY_GRAPH INCLUDED_BY_GRAPH、ENABLE_PREPROCESSING、およびSEARCH_INCLUDESタグがYESに設定されている場合、Doxygenは各ドキュメント化されたファイルに対して、他のドキュメント化されたファイルとの直接的および間接的なインクルード依存関係を示すグラフを生成します。INCLUDED_BY_GRAPHがNOに設定されている場合に、インクルード元グラフを明示的に有効にするには、\includedbygraphコマンドを使用します。インクルード元グラフを無効にするには、\hideincludedbygraphコマンドを使用します。
デフォルト値は: YES です。
このタグは、HAVE_DOTタグがYESに設定されている必要があります。
CALL_GRAPH CALL_GRAPHタグがYESに設定されている場合、Doxygenはすべてのグローバル関数またはクラスメソッドの呼び出し依存グラフを生成します。
このオプションを有効にすると、実行時間が大幅に増加することに注意してください。したがって、ほとんどの場合、\callgraphコマンドを使用して、選択された関数に対してのみ呼び出しグラフを有効にすることをお勧めします。呼び出しグラフを無効にするには、\hidecallgraphコマンドを使用します。
デフォルト値は: NO です。
このタグは、HAVE_DOTタグがYESに設定されている必要があります。
CALLER_GRAPH CALLER_GRAPHタグがYESに設定されている場合、Doxygenはすべてのグローバル関数またはクラスメソッドの呼び出し元依存グラフを生成します。
このオプションを有効にすると、実行時間が大幅に増加することに注意してください。したがって、ほとんどの場合、\callergraphコマンドを使用して、選択された関数に対してのみ呼び出し元グラフを有効にすることをお勧めします。呼び出し元グラフを無効にするには、\hidecallergraphコマンドを使用します。
デフォルト値は: NO です。
このタグは、HAVE_DOTタグがYESに設定されている必要があります。
GRAPHICAL_HIERARCHY GRAPHICAL_HIERARCHYタグがYESに設定されている場合、Doxygenはすべてのクラスの階層をテキスト形式ではなくグラフィカルに表示します。
デフォルト値は: YES です。
このタグは、HAVE_DOTタグがYESに設定されている必要があります。
DIRECTORY_GRAPH DIRECTORY_GRAPHタグがYESに設定されている場合、Doxygenはディレクトリが他のディレクトリに対して持つ依存関係をグラフィカルに表示します。依存関係は、ディレクトリ内のファイル間の#include関係によって決定されます。DIRECTORY_GRAPHがNOに設定されている場合に、ディレクトリグラフを明示的に有効にするには、\directorygraphコマンドを使用します。ディレクトリグラフを無効にするには、\hidedirectorygraphコマンドを使用します。
デフォルト値は: YES です。
このタグは、HAVE_DOTタグがYESに設定されている必要があります。
DIR_GRAPH_MAX_DEPTH DIR_GRAPH_MAX_DEPTHタグは、dotによってディレクトリ依存グラフで生成される子ディレクトリの最大レベル数を制限するために使用できます。
最小値: 1、最大値: 25、デフォルト値: 1。
このタグは、DIRECTORY_GRAPHタグがYESに設定されている必要があります。
DOT_IMAGE_FORMAT DOT_IMAGE_FORMATタグは、dotによって生成される画像の画像形式を設定するために使用できます。画像形式の説明については、dotツール（Graphviz）のドキュメントにある出力形式のセクションを参照してください。
注記: svg:cairoおよびsvg:cairo:cairo形式は、INTERACTIVE_SVGと組み合わせて使用できないことに注意してください（INTERACTIVE_SVGはNOに設定されます）。
設定可能な値は: png、jpg、gif、svg、png:gd、png:gd:gd、png:cairo、png:cairo:gd、png:cairo:cairo、png:cairo:gdiplus、png:gdiplus、png:gdiplus:gdiplus、svg:cairo、svg:cairo:cairo、svg:svg、svg:svg:core、gif:cairo、gif:cairo:gd、gif:cairo:gdiplus、gif:gdiplus、gif:gdiplus:gdiplus、gif:gd、gif:gd:gd、jpg:cairo、jpg:cairo:gd、jpg:cairo:gdiplus、jpg:gd、jpg:gd:gd、jpg:gdiplus、jpg:gdiplus:gdiplusです。
デフォルト値は png です。
このタグは、HAVE_DOTタグがYESに設定されている必要があります。
INTERACTIVE_SVG DOT_IMAGE_FORMATがsvgまたはsvg:svgまたはsvg:svg:coreに設定されている場合、このオプションをYESに設定することで、ズームとパンを可能にするインタラクティブSVG画像の生成を有効にできます。
これはInternet Explorer以外のモダンブラウザが必要であることに注意してください。Firefox、Chrome、Safari、Operaでテスト済みで動作します。
注記: DOT_IMAGE_FORMATがsvg:cairoまたはsvg:cairo:cairoに設定されている場合、このオプションは自動的に無効になります。
デフォルト値は: NO です。
このタグは、HAVE_DOTタグがYESに設定されている必要があります。
DOT_PATH DOT_PATHタグは、dotツールが見つかるパスを指定するために使用できます。空白のままにした場合、dotツールはpath（環境変数PATH）で見つかるものとみなされます。
このタグは、HAVE_DOTタグがYESに設定されている必要があります。
DOTFILE_DIRS DOTFILE_DIRSタグは、ドキュメントに含まれるdotファイルを含む1つ以上のディレクトリを指定するために使用できます（\dotfileコマンドを参照）。
このタグは、HAVE_DOTタグがYESに設定されている必要があります。
DIA_PATH Diaで作成された図をDoxygenドキュメントに含めることができます。DoxygenはDiaを実行して図を生成し、それをドキュメントに挿入します。DIA_PATHタグを使用すると、Diaバイナリが置かれているディレクトリを指定できます。空のままにした場合、Diaはデフォルトの検索パスで見つかるものとみなされます。
DIAFILE_DIRS DIAFILE_DIRSタグは、ドキュメントに含まれるDiaファイルを含む1つ以上のディレクトリを指定するために使用できます（\diafileコマンドを参照）。
PLANTUML_JAR_PATH PlantUMLを使用する場合、PLANTUML_JAR_PATHタグは、Javaがplantuml.jarファイルを見つけられるパス、または使用するjarファイルのファイル名を指定するために使用する必要があります。空白のままにした場合、PlantUMLは前処理ステップで使用または呼び出されないとみなされます。この場合、Doxygenは\startumlコマンドを検出すると警告を生成し、その図の出力を生成しません。
PLANTUML_CFG_FILE PlantUMLを使用する場合、PLANTUML_CFG_FILEタグはPlantUMLの設定ファイルを指定するために使用できます。
PLANTUML_INCLUDE_PATH PlantUMLを使用する場合、PlantUMLブロック内の!includeステートメントで指定されたファイルを、指定されたパスで検索します。
PLANTUMLFILE_DIRS PLANTUMLFILE_DIRSタグは、ドキュメントに含まれるPlantUMLファイルを含む1つ以上のディレクトリを指定するために使用できます（\plantumlfileコマンドを参照）。
DOT_GRAPH_MAX_NODES DOT_GRAPH_MAX_NODESタグは、グラフに表示されるノードの最大数を設定するために使用できます。グラフ内のノード数がこの値よりも大きくなると、Doxygenはグラフを切り詰め、ノードが赤いボックスとして表示されます。グラフのルートノードの直接の子ノードの数がすでにDOT_GRAPH_MAX_NODESよりも大きい場合、グラフはまったく表示されないことに注意してください。また、グラフのサイズはMAX_DOT_GRAPH_DEPTHによってさらに制限できることにも注意してください。
最小値: 0、最大値: 10000、デフォルト値: 50。
このタグは、HAVE_DOTタグがYESに設定されている必要があります。
MAX_DOT_GRAPH_DEPTH MAX_DOT_GRAPH_DEPTHタグは、dotによって生成されるグラフの最大深度を設定するために使用できます。深度3という値は、ルートから最大3つのエッジを介したパスをたどることで到達可能なノードのみが表示されることを意味します。ルートノードからさらに離れたノードは省略されます。このオプションを1または2に設定すると、大規模なコードベースに必要な計算時間を大幅に削減できることに注意してください。また、グラフのサイズはDOT_GRAPH_MAX_NODESによってさらに制限できることにも注意してください。深度0を使用することは、深度制限がないことを意味します。
最小値: 0、最大値: 1000、デフォルト値: 0。
このタグは、HAVE_DOTタグがYESに設定されている必要があります。
DOT_MULTI_TARGETS DOT_MULTI_TARGETSタグをYESに設定すると、dotは1回の実行で複数の出力ファイルを生成できるようになります（つまり、コマンドラインで複数の-oおよび-Tオプションを使用できます）。これによりdotの実行が高速化されますが、dotの新しいバージョン（>1.8.10）のみがこれをサポートしているため、この機能はデフォルトで無効になっています。
デフォルト値は: NO です。
このタグは、HAVE_DOTタグがYESに設定されている必要があります。
GENERATE_LEGEND GENERATE_LEGENDタグがYESに設定されている場合、Doxygenはdot生成グラフ内のさまざまなボックスと矢印の意味を説明する凡例ページを生成します。
デフォルト値は: YES です。
このタグは、HAVE_DOTタグがYESに設定されている必要があります。
DOT_CLEANUP DOT_CLEANUPタグがYESに設定されている場合、Doxygenはさまざまなグラフを生成するために使用される中間ファイルを削除します。
注: この設定はdotファイルだけでなく、msc一時ファイルにも使用されます。
デフォルト値は: YES です。
MSCGEN_TOOL \mscコマンドを使用して、Doxygenコメント内にメッセージシーケンス図を定義できます。MSCGEN_TOOLタグが空白のまま（デフォルト）の場合、Doxygenはmscgenツールの組み込みバージョンを使用して図を生成します。あるいは、MSCGEN_TOOLタグは外部ツールの名前を指定することもできます。例えば、値をprogと指定すると、Doxygenはツールをprog -T <outfile_format> -o <outputfile> <inputfile>として呼び出します。外部ツールは出力ファイル形式「png」、「eps」、「svg」、「ismap」をサポートしている必要があります。
MSCFILE_DIRS MSCFILE_DIRSタグは、ドキュメントに含まれるmscファイルを含む1つ以上のディレクトリを指定するために使用できます（\mscfileコマンドを参照）。
ソースファイルexample.ccとヘッダーファイルexample.hの2つのファイルからなるシンプルなプロジェクトがあるとします。その場合、最小限の設定ファイルは次のようになります。
INPUT = example.cc example.h
この例でQtクラスを使用し、perlが/usr/binに配置されていると仮定すると、より現実的な設定ファイルは次のようになります。
PROJECT_NAME = Example INPUT = example.cc example.h WARNINGS = YES TAGFILES = qt.tag SEARCHENGINE = NO
QdbtTabularパッケージのドキュメントを生成するために、次の設定ファイルを使用しました。
PROJECT_NAME = QdbtTabular OUTPUT_DIRECTORY = html WARNINGS = YES INPUT = examples/examples.doc src FILE_PATTERNS = *.cc *.h INCLUDE_PATH = examples TAGFILES = qt.tag SEARCHENGINE = YES
ソースからQt-1.44ドキュメントを再生成するには、次の設定ファイルを使用できます。
PROJECT_NAME = Qt
OUTPUT_DIRECTORY = qt_docs
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = YES
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
SEARCH_INCLUDES = YES
FULL_PATH_NAMES = YES
STRIP_FROM_PATH = $(QTDIR)/
PREDEFINED = USE_TEMPLATECLASS Q_EXPORT= \
QArrayT:=QArray \
QListT:=QList \
QDictT:=QDict \
QQueueT:=QQueue \
QVectorT:=QVector \
QPtrDictT:=QPtrDict \
QIntDictT:=QIntDict \
QStackT:=QStack \
QDictIteratorT:=QDictIterator \
QListIteratorT:=QListIterator \
QCacheT:=QCache \
QCacheIteratorT:=QCacheIterator \
QIntCacheT:=QIntCache \
QIntCacheIteratorT:=QIntCacheIterator \
QIntDictIteratorT:=QIntDictIterator \
QPtrDictIteratorT:=QPtrDictIterator
INPUT = $(QTDIR)/doc \
$(QTDIR)/src/widgets \
$(QTDIR)/src/kernel \
$(QTDIR)/src/dialogs \
$(QTDIR)/src/tools
FILE_PATTERNS = *.cpp *.h q*.doc
INCLUDE_PATH = $(QTDIR)/include
RECURSIVE = YES
Qt-2.1のソースには、次の設定を使用することをお勧めします。
PROJECT_NAME = Qt
PROJECT_NUMBER = 2.1
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = YES
SOURCE_BROWSER = YES
INPUT = $(QTDIR)/src
FILE_PATTERNS = *.cpp *.h q*.doc
RECURSIVE = YES
EXCLUDE_PATTERNS = *codec.cpp moc_* */compat/* */3rdparty/*
ALPHABETICAL_INDEX = YES
IGNORE_PREFIX = Q
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
INCLUDE_PATH = $(QTDIR)/include
PREDEFINED = Q_PROPERTY(x)= \
Q_OVERRIDE(x)= \
Q_EXPORT= \
Q_ENUMS(x)= \
"QT_STATIC_CONST=static const " \
_WS_X11_ \
INCLUDE_MENUITEM_DEF
EXPAND_ONLY_PREDEF = YES
EXPAND_AS_DEFINED = Q_OBJECT_FAKE Q_OBJECT ACTIVATE_SIGNAL_WITH_PARAM \
Q_VARIANT_AS
ここでは、Doxygenのプリプロセッサを使用して、通常はCプリプロセッサによって置換されるマクロ名の一部を置換しますが、完全なマクロ展開は行いません。
1.14.0