設定ファイルは、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個のディレクトリを表し、各レベルの増加はディレクトリの数を2倍にし、デフォルトであり最大値でもあるレベル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 (英語メッセージ付き韓国語)、ラトビア語、リトアニア語、マケドニア語、ノルウェー語、ペルシャ語 (ファルシ語)、ポーランド語、ポルトガル語、ルーマニア語、ロシア語、セルビア語、セルビア語-キリル文字、スロバキア語、スロベニア語、スペイン語、スウェーデン語、トルコ語、ウクライナ語、ベトナム語。
デフォルト値は: 英語です。
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のdocstringは整形済みテキストとして表示され、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を記述することはできません(結果の出力では)。エイリアスの値部分に^^を記述すると、元のファイルに物理的な改行があったかのように改行を挿入できます。エイリアスの値部分でリテラルの{、}、または,が必要な場合は、バックスラッシュ(\\endiskip)でエスケープする必要があります。これはコマンド\{および\}と競合する可能性があり、その場合はバージョン@{および@}を使用するか、二重エスケープ(\\{および\\})を使用することをお勧めします。
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がサポートするパーサーのいずれかです: 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です。
MARKDOWN_STRICT MARKDOWN_STRICTタグが有効になっている場合、Doxygenはコメント内のテキストを、Doxygenのネイティブマークアップ形式がMarkdownと競合する場合でもMarkdown形式で扱います。これはバックティックが使用される場合にのみ関係します。Doxygenのネイティブマークアップスタイルでは、バックティックで始まったテキストフラグメントを単一引用符で終了し、引用符で囲まれたテキストとして扱いますが、Markdownではそのようなテキストフラグメントは逐語的に扱われ、2番目の一致するバックティックが見つかるまで終了しません。また、Doxygenのネイティブマークアップ形式では、バックティックセクションに二重引用符が出現する場合にエスケープする必要がありますが、Markdownではこれは不要です。
デフォルト値は: YESです。
このタグには、MARKDOWN_SUPPORTタグがYESに設定されている必要があります。
TOC_INCLUDE_HEADINGS TOC_INCLUDE_HEADINGSタグが0以外の値に設定されている場合、そのレベルまでのすべての見出しは、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ソースを含めたくない場合(またはタグファイルを含めたくない場合)、DoxygenがSTLクラスを含む引数を持つ関数宣言と定義(func(std::string);とfunc(std::string) {}など)を照合できるようにするために、このタグをYESに設定する必要があります。これにより、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に設定すると、同じ型のクラスメンバーグループ(たとえば、公開関数のグループ)をその型のサブグループ(たとえば、公開関数セクションの下)に配置できます。サブグループ化を防止するには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はシステムで利用可能なコア数に基づいてこれを決定します。CPU負荷と処理速度のバランスをより細かく制御するために、明示的に0より大きい値に設定できます。現時点では、入力処理のみを複数のスレッドで実行できます。これはまだ実験的な機能であるため、デフォルトは1に設定されており、実質的に並列処理は無効になっています。遭遇した問題は報告してください。dotグラフの並列生成はDOT_NUM_THREADS設定によって制御されます。
最小値: 0, 最大値: 512, デフォルト値: 1。
TIMESTAMP TIMESTAMPタグがNOと異なる場合、生成された各ページには、ページが生成された日付または日時が含まれます。これをNOに設定すると、複数の実行の出力を比較するのに役立ちます。
可能な値は: YES, NO, DATETIME および DATE。
デフォルト値は: NOです。
EXTRACT_ALL EXTRACT_ALLタグがYESに設定されている場合、Doxygenはドキュメント内のすべてのエンティティが文書化されていると仮定します。文書化が利用できない場合でもです。プライベートクラスメンバーと静的ファイルメンバーは、EXTRACT_PRIVATEまたはEXTRACT_STATICタグがYESに設定されていない限り非表示になります。
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という2つのクラスのように、大文字と小文字のみが異なるシンボルに対して書き込まれた出力ファイルを適切に処理するために、オプションをNOに設定する必要があります。また、正確な大文字と小文字の指定を必要とせずにファイルへの参照をサポートするためにもです。
Windows (Cygwinを含む)とmacOSでは、通常このオプションをNOに設定する必要がありますが、Linuxやその他のUnix系では通常YESに設定する必要があります。
可能な値は: SYSTEM, NO, YES。
デフォルト値は: SYSTEMです。
HIDE_SCOPE_NAMES HIDE_SCOPE_NAMESタグがNOに設定されている場合、Doxygenはドキュメント内でメンバーを完全なクラスおよび名前空間スコープで表示します。YESに設定されている場合、スコープは非表示になります。
デフォルト値は: NOです。
HIDE_COMPOUND_REFERENCE HIDE_COMPOUND_REFERENCEタグがNO(デフォルト)に設定されている場合、Doxygenはページのタイトルに「クラスリファレンス」などの追加テキストを追加します。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で定義されたそれぞれの順序で表示されます。
NOに設定されている場合、簡単なメンバーのドキュメントのソートに関しては、このオプションは無視されます。NOに設定されている場合、詳細なメンバーのドキュメントのソートに関しては、このオプションは無視されます。デフォルト値は: NOです。
SORT_GROUP_NAMES SORT_GROUP_NAMESタグがYESに設定されている場合、Doxygenはグループ名の階層をアルファベット順にソートします。NOに設定されている場合、グループ名は定義された順序で表示されます。
デフォルト値は: NOです。
SORT_BY_SCOPE_NAME SORT_BY_SCOPE_NAMEタグがYESに設定されている場合、クラスリストは名前空間を含む完全修飾名でソートされます。NOに設定されている場合、クラスリストは名前空間部分を含まず、クラス名のみでソートされます。
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に設定すると、Filesページの生成が無効になります。これにより、クイックインデックスおよびフォルダーツリービュー(指定されている場合)からFilesエントリが削除されます。
デフォルト値は: YESです。
SHOW_NAMESPACES SHOW_NAMESPACESタグをNOに設定すると、Namespacesページの生成が無効になります。これにより、クイックインデックスおよびフォルダーツリービュー(指定されている場合)からNamespacesエントリが削除されます。
デフォルト値は: 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 = /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は、文書化された関数で一部のパラメータを2回文書化したり、存在しないパラメータを文書化したり、マークアップコマンドを誤って使用したりするなど、ドキュメント内の潜在的なエラーに対して警告を生成します。
デフォルト値は: 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プロセスの最後に0以外のステータスで終了します。WARN_AS_ERRORタグがFAIL_ON_WARNINGS_PRINTに設定されている場合、DoxygenはFAIL_ON_WARNINGSのように動作しますが、WARN_LOGFILEが定義されていない場合、Doxygenは警告メッセージを他のメッセージの間に書き込まず、実行の最後に書き込みます。また、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 の代わりにそのエンコーディングを適用します。文字エンコーディングは、パターン=エンコーディング（例: *.php=ISO-8859-1）の形式のリストです。
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 タグは、含まれるサンプルコード断片を含む1つ以上のファイルまたはディレクトリを指定するために使用できます（\include コマンドを参照）。
EXAMPLE_PATTERNS EXAMPLE_PATH タグの値にディレクトリが含まれている場合、EXAMPLE_PATTERNS タグを使用して、ディレクトリ内のソースファイルをフィルタリングするための1つ以上のワイルドカードパターン（*.cpp や *.h など）を指定できます。空白のままにした場合、すべてのファイルが含まれます。
EXAMPLE_RECURSIVE EXAMPLE_RECURSIVE タグが YES に設定されている場合、RECURSIVE タグの値に関係なく、\include または \dontinclude コマンドで使用する入力ファイルをサブディレクトリで検索します。
デフォルト値は: NOです。
IMAGE_PATH IMAGE_PATH タグは、ドキュメントに含める画像を含む1つ以上のファイルまたはディレクトリを指定するために使用できます（\image コマンドを参照）。
INPUT_FILTER INPUT_FILTER タグは、Doxygen が各入力ファイルに対してフィルタリングするために呼び出すプログラムを指定するために使用できます。Doxygen は、以下のコマンドを実行することで（popen() 経由で）フィルタプログラムを呼び出します。
<filter> <input-file>
ここで <filter> は INPUT_FILTER タグの値、<input-file> は入力ファイルの名前です。Doxygen は、フィルタプログラムが標準出力に書き出す出力を使用します。FILTER_PATTERNS が指定されている場合、このタグは無視されます。
フィルタは行を追加または削除してはならないことに注意してください。フィルタはコードがスキャンされる前に適用されますが、出力コードが生成されるときには適用されません。行が追加または削除されると、アンカーが正しく配置されません。
Doxygen は、標準出力に処理されて書き込まれたデータを使用してさらに処理を行うため、デバッグステートメントや使用されたコマンドなど、他の何も標準出力に書き込まないでください（したがって、Windows バッチファイルの場合は常に @echo OFF を使用してください）。
カスタム拡張子や直接サポートされていない拡張子の場合、拡張子に対して EXTENSION_MAPPING を設定しないと、ファイルは Doxygen によって適切に処理されないことに注意してください。
FILTER_PATTERNS FILTER_PATTERNS タグは、ファイルパターンごとにフィルタを指定するために使用できます。Doxygen はファイル名を各パターンと比較し、一致するものがあればフィルタを適用します。フィルタは、パターン=フィルタ（例: *.cpp=my_cpp_filter）の形式のリストです。フィルタの使用方法に関する詳細情報については、INPUT_FILTER を参照してください。FILTER_PATTERNS タグが空の場合、またはどのパターンもファイル名に一致しない場合、INPUT_FILTER が適用されます。
カスタム拡張子や直接サポートされていない拡張子の場合、拡張子に対して EXTENSION_MAPPING を設定しないと、ファイルは Doxygen によって適切に処理されないことに注意してください。
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 支援解析が有効になっている場合、コンパイラを呼び出すときに通常使用するコマンドラインオプションをコンパイラに提供できます。INPUT と INCLUDE_PATH で指定されたファイルとディレクトリについては、Doxygen によってインクルードパスが既に設定されていることに注意してください。
このタグは、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）は将来廃止される予定だからです。このタグは、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 を実行するとそのディレクトリに docset が生成され、make install を実行すると docset が ~/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 ヘルプワークショップは既に長年メンテナンスモードでした）。HTML ヘルプワークショップは、インストール実行ファイル からウェブアーカイブでダウンロードできます。
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 Compressed Help (.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 のプラグインディレクトリにコピーする必要があります。プラグインディレクトリ内のディレクトリ名は、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 Help 用に生成されるものとまったく同じです）。これが機能するには、JavaScript、DHTML、CSS、およびフレームをサポートするブラウザ（つまり、最新のブラウザ）が必要です。Windows ユーザーは、HTML ヘルプ機能を使用する方がおそらく良いでしょう。
カスタムスタイルシート（HTML_EXTRA_STYLESHEET を参照）を介して、インデックスの外観をさらに微調整できます（Fine-tuning the output を参照）。例として、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_4。
デフォルト値は MathJax_2 です。
このタグは、USE_MATHJAX タグが YES に設定されていることを必要とします。
MATHJAX_FORMAT MathJax が有効になっている場合、MathJax 出力に使用するデフォルトの出力形式を設定できます。出力形式の詳細については、MathJax version 2、MathJax version 3、および MathJax version 4 を参照してください。
可能な値は: 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 バージョン 2 の場合、宛先ディレクトリには MathJax.js スクリプトが含まれている必要があります。たとえば、mathjax ディレクトリが HTML 出力ディレクトリと同じレベルにある場合、MATHJAX_RELPATH は ../mathjax となります。Mathjax バージョン 3 および 4 の場合、宛先ディレクトリには tex-<format>.js スクリプト（<format> は chtml または svg のいずれか）が含まれている必要があります。デフォルト値は MathJax Content Delivery Network を指しているため、MathJax をインストールしなくてもすぐに結果を確認できます。ただし、デプロイ前に https://www.mathjax.org から MathJax のローカルコピーをインストールすることを強くお勧めします。
デフォルト値は次の通りです。
このタグは、USE_MATHJAX タグが YES に設定されていることを必要とします。
MATHJAX_EXTENSIONS MATHJAX_EXTENSIONS タグは、MathJax レンダリング中に有効にする1つ以上の MathJax 拡張機能名を指定するために使用できます。たとえば、MathJax バージョン 2 の場合（https://docs.mathjax.org/en/v2.7/tex.html を参照）
MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
たとえば、MathJax バージョン 3 の場合（https://docs.mathjax.org/en/v3.2/input/tex/extensions/ を参照）
MATHJAX_EXTENSIONS = ams
たとえば、MathJax バージョン 4 の場合（https://docs.mathjax.org/en/v4.0/input/tex/extensions/ を参照）
MATHJAX_EXTENSIONS = units
Mathjax バージョン 4 では、かなりの数の拡張機能が既に自動的にロードされることに注意してください。Mathjax バージョン 4 でパッケージを無効にするには、パッケージ名の前にマイナス記号（-、例: MATHJAX_EXTENSIONS += -textmacros）を付けて使用できます。
このタグは、USE_MATHJAX タグが YES に設定されていることを必要とします。
MATHJAX_CODEFILE MATHJAX_CODEFILE タグは、MathJax コードの起動時に使用される JavaScript コード断片を含むファイルを指定するために使用できます。詳細については MathJax サイトを参照してください。
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）、または docset（GENERATE_DOCSET）を使用している場合、既に検索機能があるため、これは通常無効にすべきです。大規模なプロジェクトでは JavaScript ベースの検索エンジンは遅くなる可能性があるため、SERVER_BASED_SEARCH を有効にすると、より良い解決策が得られるかもしれません。
キーボードを使用して検索することも可能です。検索ボックスにジャンプするには <アクセスキー> + S を使用します（<アクセスキー> は OS やブラウザによって異なりますが、通常は <CTRL>、<ALT>/<option>、またはその両方です）。検索ボックス内で <カーソル下キー> を使用して検索結果ウィンドウにジャンプし、<カーソルキー> を使用して結果をナビゲートできます。<Enter> を押して項目を選択するか、<Escape> を押して検索をキャンセルします。フィルタオプションは、カーソルが検索ボックス内にあるときに <Shift>+<カーソル下> を押すことで選択できます。ここでも、<カーソルキー> を使用してフィルタを選択し、<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 タグは、 のインデックスを生成するコマンド名を指定するために使用できます。最初の文字としてバックスラッシュ (\endiskip) がない場合、 コードに自動的に追加されます。
デフォルト値は 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$latexbibfiles$papertype 用紙タイプとなるように「paper」という単語が直接追加されます。$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_FONTENCFORMULA_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 (write) などはリンクをサポートしていません。
デフォルト値は: 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 に MAN_EXTENSION（先頭の . は削除されます）が続きます。
このタグには、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 Definitions（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 になります。タグファイルの使用方法の詳細については、Linking to external documentation のセクションを参照してください。
GENERATE_TAGFILE GENERATE_TAGFILE の後にファイル名が指定されている場合、Doxygen は読み込んだ入力ファイルに基づいてタグファイルを生成します。タグファイルの使用方法の詳細については、Linking to external documentation のセクションを参照してください。
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、最大値: 512、デフォルト値: 0。
このタグには、HAVE_DOT タグが YES に設定されている必要があります。
DOT_COMMON_ATTR DOT_COMMON_ATTR は、サブグラフのノード、エッジ、およびラベルの共通属性です。Doxygen が生成する dot ファイルで異なるフォントが必要な場合、fontname、fontcolor、fontsize 属性を指定できます。詳細については、ノード、エッジ、およびグラフ属性の仕様を参照してください。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_COMMON_ATTR および他の dot 属性で fontname で指定されたフォントを dot が見つけられるパスを設定できます。
このタグには、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 の Unified Modeling Language に似たスタイルで継承図とコラボレーション図を生成します。
デフォルト値は: 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 で見つかると仮定されます。
このタグには、HAVE_DOT タグが YES に設定されている必要があります。
DOTFILE_DIRS DOTFILE_DIRS タグは、ドキュメントに含まれる dot ファイルを含む1つ以上のディレクトリを指定するために使用できます（\dotfile コマンドを参照）。
このタグには、HAVE_DOT タグが YES に設定されている必要があります。
DIA_PATH Doxygen ドキュメントに dia で作成された図を含めることができます。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 Doxygen コメント内で \msc コマンドを使用してメッセージシーケンス図を定義できます。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.15.0 で生成