設定ファイルは、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_PATH タグをこれらのパスとともに @INCLUDE タグの前に記述します (例:)。
@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 つ増えるごとにディレクトリ数が 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 はこの情報を使用して、すべての定数出力を適切な言語で生成します。
使用可能な値は、Afrikaans、Arabic、Armenian、Brazilian、Bulgarian、Catalan、Chinese、Chinese-Traditional、Croatian、Czech、Danish、Dutch、English (米国)、Esperanto、Farsi (ペルシア語)、Finnish、French、German、Greek、Hindi、Hungarian、Indonesian、Italian、Japanese、Japanese-en (英語メッセージ付き日本語)、Korean、Korean-en (英語メッセージ付き韓国語)、Latvian、Lithuanian、Macedonian、Norwegian、Persian (ペルシア語)、Polish、Portuguese、Romanian、Russian、Serbian、Serbian-Cyrillic、Slovak、Slovene、Spanish、Swedish、Turkish、Ukrainian、Vietnamese です。
デフォルト値は 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 ドキュメンテーション文字列は整形済みテキストとして表示され、Doxygen の特殊コマンドは使用できません。 PYTHON_DOCSTRING を NO に設定すると、Doxygen の特殊コマンドを使用できるようになり、ドキュメンテーション文字列ドキュメントブロックの内容が 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 でサポートされているパーサーのいずれかです: 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 タグが 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 ソースの (タグファイルを) 入力として含めたくない場合は、このタグを YES に設定する必要があります。これにより、Doxygen は、引数に STL クラスを含む関数宣言と定義 (例えば 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 では、プロパティの getter および setter メソッドを示すために propget および propput 属性があります。このオプションを YES に設定すると、Doxygen はドキュメント内の get および set メソッドをプロパティに置き換えます。これは、メソッドが実際に単純な型を取得または設定している場合にのみ機能します。そうでない場合、またはとにかくメソッドを表示したい場合は、このオプションを NO に設定する必要があります。
デフォルト値は YES です。
DISTRIBUTE_GROUP_DOC ドキュメントでメンバのグループ化が使用されており、DISTRIBUTE_GROUP_DOC タグが YES に設定されている場合、Doxygen はグループ内の最初のメンバ (存在する場合) のドキュメントを、グループの他のメンバに対して再利用します。デフォルトでは、グループのすべてのメンバは明示的にドキュメント化する必要があります。
デフォルト値は NO です。
GROUP_NESTED_COMPOUNDS struct または class をグループに追加し、このオプションが有効になっている場合、ネストされた class または struct も同じグループに追加されます。デフォルトでは、このオプションは無効になっており、ネストされたコンパウンドは \ingroup を介して明示的に追加する必要があります。
デフォルト値は NO です。
SUBGROUPING 同じタイプのクラスメンバグループ (例えば、public 関数のグループ) をそのタイプ (例えば、Public Functions セクションの下) のサブグループとして配置できるようにするには、SUBGROUPING タグを YES に設定します。サブグループ化を防止するには、NO に設定します。または、\nosubgrouping コマンドを使用して、クラスごとにこれを行うこともできます。
デフォルト値は YES です。
INLINE_GROUPED_CLASSES INLINE_GROUPED_CLASSES タグが YES に設定されている場合、class、struct、および union は、(\ingroup を使用するなどして) 含まれているグループ内に表示され、別のページ (HTML および Man ページの場合) またはセクション (
および RTF の場合) には表示されません。
この機能は、SEPARATE_MEMBER_PAGES と組み合わせて使用できないことに注意してください。
デフォルト値は NO です。
INLINE_SIMPLE_STRUCTS INLINE_SIMPLE_STRUCTS タグが YES に設定されている場合、public データフィールドまたは単純な typedef フィールドのみを持つ struct、class、および union は、定義されているスコープ (つまり、ファイル、名前空間、またはグループドキュメント) のドキュメントにインラインで表示されます。ただし、このスコープがドキュメント化されている場合に限ります。 NO に設定すると、struct、class、および union は、別のページ (HTML および Man ページの場合) またはセクション ( および RTF の場合) に表示されます。
デフォルト値は NO です。
TYPEDEF_HIDES_STRUCT TYPEDEF_HIDES_STRUCT タグが有効になっている場合、struct、union、または enum の typedef は、typedef の名前を持つ struct、union、または enum としてドキュメント化されます。したがって、typedef struct TypeS {} TypeT は、ドキュメントでは TypeT という名前の struct として表示されます。無効にすると、typedef はファイル、名前空間、またはクラスのメンバとして表示されます。そして、struct は 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_NUM_THREADS 設定によって制御されます。
最小値: 0、最大値: 32、デフォルト値: 1。
TIMESTAMP TIMESTAMP タグが NO と異なる値に設定されている場合、生成された各ページには、ページが生成された日付または日時が含まれます。これを NO に設定すると、複数回の実行の出力を比較するのに役立ちます。
可能な値は次のとおりです: YES、NO、DATETIME、および DATE。
デフォルト値は NO です。
EXTRACT_ALL EXTRACT_ALL タグが YES に設定されている場合、Doxygen はドキュメント内のすべてのエンティティがドキュメント化されていると見なします。ドキュメントが利用できない場合でも同様です。 private クラスメンバと static ファイルメンバは、EXTRACT_PRIVATE および EXTRACT_STATIC タグがそれぞれ YES に設定されていない限り、非表示になります。
YES に設定されている場合に通常生成される、ドキュメント化されていないメンバに関する警告も無効にします。デフォルト値は NO です。
EXTRACT_PRIVATE EXTRACT_PRIVATE タグが YES に設定されている場合、クラスのすべての private メンバがドキュメントに含まれます。
デフォルト値は NO です。
EXTRACT_PRIV_VIRTUAL EXTRACT_PRIV_VIRTUAL タグが YES に設定されている場合、ドキュメント化されたクラスの private virtual メソッドがドキュメントに含まれます。
デフォルト値は NO です。
EXTRACT_PACKAGE EXTRACT_PACKAGE タグが YES に設定されている場合、package または internal スコープを持つすべてのメンバがドキュメントに含まれます。
デフォルト値は NO です。
EXTRACT_STATIC EXTRACT_STATIC タグが YES に設定されている場合、ファイルのすべての static メンバがドキュメントに含まれます。
デフォルト値は NO です。
EXTRACT_LOCAL_CLASSES EXTRACT_LOCAL_CLASSES タグが YES に設定されている場合、ソースファイルでローカルに定義されたクラス (および struct) がドキュメントに含まれます。 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 はすべての friend 宣言を非表示にします。 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 に設定する必要があります。
ファイルシステムがケースインセンシティブである場合、オプションは NO に設定して、CLASS という名前のクラスと Class という名前の別のクラスなど、ケーシングのみが異なるシンボルに対して書き込まれた出力ファイルを適切に処理し、正確な一致ケーシングを指定しなくてもファイルへの参照もサポートする必要があります。
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 はページのタイトルに追加のテキスト (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 で定義されたそれぞれの順序で表示されます。
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 クラスと struct のドキュメントの下部に生成されるファイルのリストを無効にするには、SHOW_USED_FILES タグを NO に設定します。 YES に設定すると、リストにはドキュメントの生成に使用されたファイルが記載されます。
デフォルト値は YES です。
SHOW_FILES Files ページの生成を無効にするには、SHOW_FILES タグを NO に設定します。これにより、Files エントリがクイックインデックスと (指定されている場合は) フォルダツリービューから削除されます。
デフォルト値は YES です。
SHOW_NAMESPACES Namespaces ページの生成を無効にするには、SHOW_NAMESPACES タグを NO に設定します。これにより、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_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 など) の形式のリストです。
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++、*.ixx、*.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ディレクトリを除外するには、パターン */test/* を使用します。
EXCLUDE_SYMBOLS EXCLUDE_SYMBOLS タグは、出力から除外する必要がある1つまたは複数のシンボル名（名前空間、クラス、関数など）を指定するために使用できます。シンボル名は、完全修飾名、単語、またはワイルドカード * が使用されている場合は、部分文字列にすることができます。例：ANamespace、AClass、ANamespace::AClass、ANamespace::*Test
EXAMPLE_PATH EXAMPLE_PATH タグは、(\include コマンドを参照) 含まれるサンプルコードの断片を含む1つまたは複数のファイルまたはディレクトリを指定するために使用できます。
EXAMPLE_PATTERNS EXAMPLE_PATH タグの値にディレクトリが含まれている場合、EXAMPLE_PATTERNS タグを使用して、ディレクトリ内のソースファイルをフィルタリングするための1つまたは複数のワイルドカードパターン（*.cpp や *.h など）を指定できます。空白のままにすると、すべてのファイルが含まれます。
EXAMPLE_RECURSIVE EXAMPLE_RECURSIVE タグが YES に設定されている場合、サブディレクトリは、\include または \dontinclude コマンドで使用される入力ファイルを検索します。RECURSIVE タグの値に関係なく。
デフォルト値は NO です。
IMAGE_PATH IMAGE_PATH タグは、ドキュメントに含める画像 (\image コマンドを参照) を含む1つまたは複数のファイルまたはディレクトリを指定するために使用できます。
INPUT_FILTER INPUT_FILTER タグは、Doxygenが各入力ファイルをフィルタリングするために呼び出すプログラムを指定するために使用できます。Doxygenは、コマンド
<filter> <input-file>
(popen() 経由) を実行することにより、フィルタプログラムを呼び出します。ここで、<filter> は INPUT_FILTER タグの値であり、<input-file> は入力ファイルの名前です。Doxygenは、フィルタプログラムが標準出力に書き込む出力を使用します。FILTER_PATTERNS が指定されている場合、このタグは無視されます。
フィルタは行を追加または削除してはならないことに注意してください。コードがスキャンされる前に適用されますが、出力コードが生成されるときには適用されません。行が追加または削除された場合、アンカーは正しく配置されません。
Doxygenは、さらなる処理のために標準出力に処理および書き込まれたデータを使用することに注意してください。したがって、デバッグステートメントや使用されたコマンド (Windowsバッチファイルの場合は常に @echo OFF を使用するなど) など、他のものを標準出力に書き込んではなりません。
カスタム拡張子または直接サポートされていない拡張子の場合、拡張子に対して EXTENSION_MAPPING も設定する必要があります。そうしないと、ファイルはDoxygenによって適切に処理されません。
FILTER_PATTERNS FILTER_PATTERNS タグは、ファイルパターンごとにフィルタを指定するために使用できます。Doxygenは、ファイル名を各パターンと比較し、一致するものがある場合はフィルタを適用します。フィルタは、pattern=filter (例: *.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 タグが入力の一部であるMarkdownファイルの名前を参照している場合、その内容がメインページ (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 に設定すると、関数、複数行マクロ、enum、またはリストで初期化された変数の本体がドキュメントに直接含まれます。
デフォルト値は 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 parser を使用します。これは、Doxygenの組み込みパーサーに必要な型情報が不足している、テンプレートが豊富なC++コードで特に役立ちます。
-Duse_libclang=ON オプションで生成されたかどうかに依存します。デフォルト値は 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 で指定されたオプションも追加されます。
-Duse_libclang=ON オプションで生成されたかどうかに依存します。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
doxygen -w header new_header.html
次に、ファイル new_header.html を変更します。
ヘッダーは変更される可能性があるため、通常、Doxygenの新しいバージョンにアップグレードするときにデフォルトヘッダーを再生成する必要があります。次のマーカーは、ヘッダーとフッター内で特別な意味を持ちます。$titleページのタイトルに置き換えられます。$datetime現在の日付と時刻に置き換えられます。$date現在の日付に置き換えられます。$time現在の時刻に置き換えられます。$year現在の年に置き換えられます。$showdate(<format>)<format> で指定された形式に従って、現在の日付と時刻に置き換えられます。 <format> は、\showdate コマンドに指定されているルールに従いますが、<format> に ) は許可されないという例外があります。$doxygenversionDoxygenのバージョンに置き換えられます$projectnameプロジェクト名 (PROJECT_NAME を参照) に置き換えられます$projectnumberプロジェクト番号 (PROJECT_NUMBER を参照) に置き換えられます$projectbriefプロジェクトの簡単な説明 (PROJECT_BRIEF を参照) に置き換えられます$projectlogoプロジェクトロゴ (PROJECT_LOGO を参照) に置き換えられます$generatedby「Generated by」というテキストの出力言語依存バージョン、または TIMESTAMP が設定されている場合は、「Generated on $datetime for $projectname by」というテキストの出力言語依存バージョンに置き換えられます。$stylesheetHTML_STYLESHEET の設定に置き換えられます。空の場合、またはファイルの場合は、デフォルト設定 doxygen.css に置き換えられます。$extrastylesheet各追加スタイルシートに必要なHTMLタグを含む、HTML_EXTRA_STYLESHEET の設定に置き換えられます。$treeviewナビゲーションツリーに必要なJavaScriptとスタイルシートへのリンク (または GENERATE_TREEVIEW が無効になっている場合は空の文字列) に置き換えられます。$search検索エンジンに必要なJavaScriptとスタイルシートへのリンク (または SEARCHENGINE が無効になっている場合は空の文字列) に置き換えられます。$searchbox検索ボックスを表示するために必要なHTMLコード (または SEARCHENGINE が無効になっている場合は空の文字列) に置き換えられます。$mathjaxMathJax機能に必要なJavaScriptとスタイルシートへのリンク (または USE_MATHJAX が無効になっている場合は空の文字列) に置き換えられます。$relpath^CREATE_SUBDIRS が有効になっている場合、コマンド $relpath^ を使用して、HTML出力ディレクトリのルートへの相対パスを生成できます。たとえば、標準スタイルシートを参照するには、$relpath^doxygen.css を使用します。$navpathGENERATE_TREEVIEW に必要なパスに置き換えられます
<!--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_TREEVIEW...SEARCHENGINEPROJECT_NAMEPROJECT_NUMBERDISABLE_INDEXPROJECT_BRIEFPROJECT_LOGOGENERATE_TREEVIEWFULL_SIDEBARSEARCHENGINEPROJECT_NAME
HTML_FOOTER ブロック内のコンテンツは、PROJECT_NAME オプションが空でない場合に出力にコピーされます。
PROJECT_NUMBER
ブロック内のコンテンツは、PROJECT_NUMBER オプションが空でない場合に出力にコピーされます。
PROJECT_BRIEF
HTML_STYLESHEET ブロック内のコンテンツは、PROJECT_BRIEF オプションが空でない場合に出力にコピーされます。
PROJECT_LOGO
FULL_SIDEBAR
HTML_EXTRA_STYLESHEET TITLEAREAbody {
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_FOOTER タグは、生成された各HTMLページに対してユーザー定義のHTMLフッターを指定するために使用できます。タグが空白のままの場合、Doxygenは標準フッターを生成します。
デフォルトフッターを生成する方法と、フッター内で使用できる特別なコマンドの詳細については、HTML_HEADER を参照してください。
HTML_COLORSTYLE Doxygenが通常使用するデフォルトフッターを生成する方法の詳細については、セクション Doxygen usage も参照してください。
このタグは、タグ GENERATE_HTML が YES に設定されている必要があります。
HTML_STYLESHEET タグは、各HTMLページで使用されるユーザー定義のカスケードスタイルシートを指定するために使用できます。 HTML出力の外観を微調整するために使用できます。空白のままにすると、Doxygenはデフォルトのスタイルシートを生成します。
Doxygenが通常使用するスタイルシートを生成する方法の詳細については、セクション Doxygen usage も参照してください。
HTML_COLORSTYLE_HUE このタグ ( HTML_STYLESHEET ) は将来廃止される予定であり、より堅牢な HTML_EXTRA_STYLESHEET を代わりに使用することをお勧めします。
このタグは、タグ GENERATE_HTML が YES に設定されている必要があります。
HTML_EXTRA_STYLESHEET タグは、Doxygenによって作成された標準スタイルシートの後に含まれる追加のユーザー定義カスケードスタイルシートを指定するために使用できます。このオプションを使用すると、特定のスタイル側面を上書きできます。これは、標準スタイルシートを置き換えす、したがって将来の更新に対してより堅牢であるため、HTML_STYLESHEET を使用するよりも推奨されます。 Doxygenは、スタイルシートファイルをoutputディレクトリにコピーします。
HTML_COLORSTYLE_SAT 追加のスタイルシートファイルの順序は重要です (例: リスト内の最後のスタイルシートは、リスト内の前のスタイルの設定を上書きします)。
スクロールバーのスタイリングは、現在Webkit/Chromiumで上書きできないため、1つ以上の追加のスタイルシートが指定されている場合、スタイリングはデフォルトのdoxygen.cssから除外されます。したがって、スクロールバーのカスタマイズが必要な場合は、明示的に追加する必要があります。コンテンツ領域に固定幅を与えるスタイルシートの例を次に示します。
div.contents {
HTML_COLORSTYLE_GAMMA width: 800px;
}
このタグは、タグ GENERATE_HTML が YES に設定されている必要があります。
HTML_DYNAMIC_MENUS HTML_EXTRA_FILES タグは、HTML出力ディレクトリにコピーする必要がある1つまたは複数の追加の画像またはその他のソースファイルを指定するために使用できます。これらのファイルは、ベースHTML出力ディレクトリにコピーされることに注意してください。 HTML_HEADER および/または HTML_FOOTER ファイルで $relpath^ マーカーを使用して、これらのファイルをロードします。 HTML_STYLESHEET ファイルでは、ファイル名のみを使用します。また、ファイルはそのままコピーされることに注意してください。コマンドまたはマーカーは使用できません。
デフォルト値は YES です。
このタグは、タグ GENERATE_HTML が YES に設定されている必要があります。
HTML_DYNAMIC_SECTIONS HTML_COLORSTYLE タグは、生成されたHTML出力をダークまたはライトテーマでレンダリングするかどうかを指定するために使用できます。
デフォルト値は NO です。
可能な値は次のとおりです。LIGHT は常にライトモード出力を生成します。DARK は常にダークモード出力を生成します。AUTO_LIGHT はユーザー設定に従ってモードを自動的に設定し、設定がない場合はライトモードを使用します (デフォルト)。AUTO_DARK はユーザー設定に従ってモードを自動的に設定し、設定がない場合はダークモードを使用します。 TOGGLE はユーザーがボタンを介してライトモードとダークモードを切り替えることを可能にします。
HTML_CODE_FOLDING デフォルト値は: AUTO_LIGHT です。
デフォルト値は YES です。
このタグは、タグ GENERATE_HTML が YES に設定されている必要があります。
HTML_COPY_CLIPBOARD HTML_COLORSTYLE_HUE タグは、HTML出力の色を制御します。Doxygenは、この色に従ってスタイルシートと背景画像の色を調整します。色相は、カラーホイールの角度として指定されます。詳細については、https://en.wikipedia.org/wiki/Hue を参照してください。たとえば、値0は赤、60は黄色、120は緑、180はシアン、240は青、300は紫、360は再び赤を表します。
デフォルト値は YES です。
最小値: 0、最大値: 359、デフォルト値: 220。
HTML_PROJECT_COOKIE このタグは、タグ GENERATE_HTML が YES に設定されている必要があります。
HTML_COLORSTYLE_SAT タグは、HTML出力の色純度 (または彩度) を制御します。値が0の場合、出力はグレースケールのみを使用します。値が255の場合、最も鮮やかな色が生成されます。
HTML_INDEX_NUM_ENTRIES 最小値: 0、最大値: 255、デフォルト値: 100。
最小値: 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 は index.hhp、index.hhc、index.hhk の 3 つの追加 HTML インデックスファイルを生成します。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 フラグは、バイナリ目次を生成するか (YES)、通常の目次を生成するか (NO) を .chm ファイルで制御します。さらに、Previous および Next ボタンを有効にします。
デフォルト値は NO です。
このタグは、タグ GENERATE_HTMLHELP が YES に設定されている必要があります。
TOC_EXPAND TOC_EXPAND フラグを YES に設定すると、グループメンバーの追加項目を HTML ヘルプドキュメントの目次とツリービューに追加できます。
デフォルト値は 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 の 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 に設定できます。
デフォルト値は YES です。
このタグは、タグ GENERATE_HTML が YES に設定されている必要があります。
GENERATE_TREEVIEW GENERATE_TREEVIEW タグは、階層情報を表示するためにツリー状のインデックス構造を生成するかどうかを指定するために使用されます。タグ値が YES に設定されている場合、ツリー状のインデックス構造を含むサイドパネルが生成されます (HTML Help 用に生成されるものと同様)。これが機能するためには、JavaScript、DHTML、CSS、およびフレームをサポートするブラウザー (つまり、最新のブラウザー) が必要です。Windows ユーザーは、HTML ヘルプ機能を使用する方が適切でしょう。
カスタムスタイルシート (HTML_EXTRA_STYLESHEET を参照) を介して、インデックスの外観をさらに微調整できます (出力の微調整 を参照)。例として、Doxygen によって生成されるデフォルトのスタイルシートには、PROJECT_NAME の代わりにツリーのルートに画像を配置する方法を示す例が含まれています。
ツリーは基本的にタブインデックスと同じ情報を持っているため、このオプションを有効にする場合は、DISABLE_INDEX を YES に設定することを検討できます。
デフォルト値は YES です。
このタグは、タグ GENERATE_HTML が YES に設定されている必要があります。
FULL_SIDEBAR GENERATE_TREEVIEW と DISABLE_INDEX の両方が YES に設定されている場合、FULL_SIDEBAR オプションは、サイドバーをツリービュー領域のみに限定するか (値 NO)、ウィンドウの高さ全体に拡張するか (値 YES) を決定します。これを YES に設定すると、https://docs.readthedocs.io に似たレイアウトになり、コンテンツのスペースは広くなりますが、プロジェクトのロゴ、タイトル、説明のスペースは狭くなります。
GENERATE_TREEVIEW または DISABLE_INDEX のいずれかが NO に設定されている場合、このオプションは効果がありません。
デフォルト値は NO です。
このタグは、タグ GENERATE_HTML が YES に設定されている必要があります。
ENUM_VALUES_PER_LINE ENUM_VALUES_PER_LINE タグは、生成された HTML ドキュメントで Doxygen が 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 コマンドを含めることができます。詳細については、数式の組み込み セクションを参照してください。
USE_MATHJAX MathJax (https://www.mathjax.org を参照) を使用して 数式をレンダリングするには、USE_MATHJAX オプションを有効にします。MathJax は、プリレンダリングされたビットマップを使用する代わりに、クライアント側の 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 version 2 および MathJax version 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 コンテンツ配信ネットワークを指しているため、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-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)、または 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 を使用する Web クライアントではなく、Web サーバーを使用して実装されます。
EXTERNAL_SEARCH 設定に応じて、Web サーバーベースの検索には 2 つの種類があります。無効にすると、Doxygen は検索用の PHP スクリプトとスクリプトで使用されるインデックスファイルを生成します。EXTERNAL_SEARCH が有効になっている場合、インデックス作成と検索は外部ツールによって提供される必要があります。詳細については、外部インデックス作成と検索 セクションを参照してください。
デフォルト値は NO です。
このタグは、タグ SEARCHENGINE が YES に設定されている必要があります。
EXTERNAL_SEARCH EXTERNAL_SEARCH タグが有効になっている場合、Doxygen は検索用の PHP スクリプトを生成しなくなります。代わりに、検索結果は XML ファイルに書き込まれ、外部インデクサーによって処理される必要があります。Doxygen は、検索結果を取得するために、SEARCHENGINE_URL オプションで指定された外部検索エンジンを呼び出します。
Doxygen には、オープンソースの検索エンジンライブラリ Xapian に基づく、サンプルのインデクサー (doxyindexer) と検索エンジン (doxysearch.cgi) が付属しています。
詳細については、外部インデックス作成と検索 セクションを参照してください。
デフォルト値は NO です。
このタグは、タグ SEARCHENGINE が YES に設定されている必要があります。
SEARCHENGINE_URL SEARCHENGINE_URL は、EXTERNAL_SEARCH が有効になっている場合に検索結果を返す Web サーバーによってホストされる検索エンジンを指している必要があります。
Doxygen には、オープンソースの検索エンジンライブラリ Xapian に基づく、サンプルのインデクサー (doxyindexer) と検索エンジン (doxysearch.cgi) が付属しています。詳細については、外部インデックス作成と検索 セクションを参照してください。
このタグは、タグ 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 タグは、 のインデックスを生成するためのコマンド名を指定するために使用できます。
Makefile / make.bat で使用されます。.tex) の部分に使用されます。デフォルトのファイルは makeindex です。
このタグは、GENERATE_LATEX タグが YES に設定されていることを要求します。
LATEX_MAKEINDEX_CMD LATEX_MAKEINDEX_CMD タグは、 のインデックスを生成するためのコマンド名を指定するために使用できます。最初の文字がバックスラッシュ (\) でない場合、 コード内で自動的に追加されます。
.tex) で使用されます。Makefile / make.bat の部分に使用されます。デフォルト値は 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 を変更します。
次に、ファイル new_header.html を変更します。
注: ユーザー定義のヘッダーは、何をしているかを理解している場合にのみ使用してください！
ヘッダーは変更される可能性があるため、通常、Doxygenの新しいバージョンにアップグレードするときにデフォルトヘッダーを再生成する必要があります。次のマーカーは、ヘッダーとフッター内で特別な意味を持ちます。ページのタイトルに置き換えられます。$datetime現在の日付と時刻に置き換えられます。$date現在の日付に置き換えられます。$time現在の時刻に置き換えられます。$year現在の年に置き換えられます。$showdate(<format>)<format> で指定された形式に従って、現在の日付と時刻に置き換えられます。 <format> は、\showdate コマンドに指定されているルールに従いますが、<format> に ) は許可されないという例外があります。$doxygenversionDoxygenのバージョンに置き換えられます$projectnameプロジェクト名 (PROJECT_NAME を参照) に置き換えられます$projectnumberプロジェクト番号 (PROJECT_NUMBER を参照) に置き換えられます$projectbriefプロジェクトの簡単な説明 (PROJECT_BRIEF を参照) に置き換えられます$projectlogo$latexdocumentpre$latexdocumentpost と組み合わせて使用されます。$latexdocumentpost$latexdocumentpre と組み合わせて使用されます。プロジェクトロゴ (PROJECT_LOGO を参照) に置き換えられます$generatedby$latexcitereferenceCITATIONS_PRESENT と組み合わせて使用されます。$latexbibstyleplain が使用されます。この設定は通常、ブロック名 CITATIONS_PRESENT と組み合わせて使用されます。$latexbibfilesbib ファイルのコンマ区切りリストに置き換えられます (必要な場合は、不足している .bib が自動的に追加されます)。この設定は通常、ブロック名 CITATIONS_PRESENT と組み合わせて使用されます。$papertype 用紙タイプにするために "paper" という単語が直接付加されます。$langISO$languagesupport$latexfontencLATEX_FONTENC と組み合わせて使用されます。$latexfont$latexemojidirectory で使用可能) に置き換えられます。LATEX_EMOJI_DIRECTORY が空の場合、現在のディレクトリが使用されます。$makeindex\makeindex コマンドが使用されます。$extralatexpackages$extralatexstylesheet.sty の場合、この拡張子はパッケージ名から削除されます)。$latexspecialformulachars$formulamacrofileFORMULA_MACROFILE と組み合わせて使用されます。設定の違いによるヘッダーとフッターのレイアウトの違いに対処するために、ヘッダーとフッターには特別なブロックを含めることもできます。これらのブロックは、構成設定に応じて出力にコピーされるか、スキップされます。このようなブロックは、次の形式を持ちます。
%%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$formulamacrofile と組み合わせて使用されます。次のブロック名は、ドキュメントで機能が使用されているかどうかに基づいて設定されます。
CITATIONS_PRESENT$latexcitereference、$latexbibstyle、および $latexbibfiles と組み合わせて使用されます。このタグは、GENERATE_LATEX タグが YES に設定されていることを要求します。
LATEX_FOOTER LATEX_FOOTER タグは、生成された ドキュメントのユーザー定義の フッターを指定するために使用できます。フッターには、最後の章以降のすべてを含める必要があります。空白のままにすると、Doxygen は標準フッターを生成します。
デフォルトのフッターを生成する方法、およびフッター内で使用できる特別なコマンドの詳細については、LATEX_HEADER を参照してください。
ブロック内のコンテンツは、PROJECT_NUMBER オプションが空でない場合に出力にコピーされます。
注: ユーザー定義のフッターは、何をしているかを理解している場合にのみ使用してください！
このタグは、GENERATE_LATEX タグが YES に設定されていることを要求します。
LATEX_EXTRA_STYLESHEET LATEX_EXTRA_STYLESHEET タグは、Doxygen によって作成された標準スタイルシートの後に含まれる追加のユーザー定義 スタイルシートを指定するために使用できます。このオプションを使用すると、特定のスタイル側面を上書きできます。Doxygen は、スタイルシートファイルを 出力ディレクトリにコピーします。TITLEAREAYES に設定されていることを要求します。LATEX_EXTRA_FILES LATEX_EXTRA_FILES タグは、LATEX_OUTPUT 出力ディレクトリにコピーする必要がある1つまたは複数の追加の画像またはその他のソースファイルを指定するために使用できます。ファイルはそのままコピーされることに注意してください。使用可能なコマンドやマーカーはありません。
このタグは、GENERATE_LATEX タグが YES に設定されていることを要求します。
PDF_HYPERLINKS PDF_HYPERLINKS タグが YES に設定されている場合、生成される は (ps2pdf または pdflatex を使用して) PDF に変換できるように準備されます。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 の使用法 セクションも参照してください。
このタグは、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 ページが配置される MAN_OUTPUT 内に作成されるディレクトリの名前を決定します。デフォルトは man に続いて、先頭の . が削除された MAN_EXTENSION が続きます。
このタグは、GENERATE_MAN タグが YES に設定されていることを要求します。
MAN_LINKS MAN_LINKS タグが YES に設定されており、Doxygen が man 出力を生成する場合、実際Man ページでドキュメント化されたエンティティごとに1つの追加の man ファイルを生成します。これらの追加ファイルは実際の 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 にすることができます。タグファイルの使用に関する詳細については、外部ドキュメントへのリンク セクションを参照してください。
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_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 を使用して実現できます。
マニュアルの Grouping の章も参照してください。
デフォルト値は 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 に設定されている必要があります。
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 を選択する場合は、SVG ファイルを IE 9 以降で表示できるようにするために、HTML_FILE_EXTENSION を xhtml に設定する必要があります（他のブラウザにはこの要件はありません）。可能な値は: 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 です。
デフォルト値: png。
このタグは、タグ HAVE_DOT が YES に設定されている必要があります。
INTERACTIVE_SVG DOT_IMAGE_FORMAT が svg に設定されている場合、このオプションを YES に設定すると、ズームとパンを可能にするインタラクティブな SVG 画像の生成を有効にできます。
これには、Internet Explorer 以外の最新のブラウザが必要であることに注意してください。Firefox、Chrome、Safari、および Opera でテスト済みで動作しています。
xhtml に設定する必要があります。古いバージョンの IE は SVG をサポートしていません。デフォルト値は NO です。
このタグは、タグ HAVE_DOT が YES に設定されている必要があります。
DOT_PATH DOT_PATH タグは、dot ツールがあるパスを指定するために使用できます。空白のままにすると、dot ツールが path にあると見なされます。
このタグは、タグ HAVE_DOT が YES に設定されている必要があります。
DOTFILE_DIRS DOTFILE_DIRS タグは、ドキュメントに含まれる dot ファイル（\dotfile コマンドを参照）を含む 1 つまたは複数のディレクトリを指定するために使用できます。
このタグは、タグ HAVE_DOT が YES に設定されている必要があります。
DIA_PATH dia で作成した図を Doxygen ドキュメントに含めることができます。Doxygen は dia を実行して図を生成し、ドキュメントに挿入します。DIA_PATH タグを使用すると、dia バイナリが存在するディレクトリを指定できます。空白のままにすると、dia はデフォルトの検索パスにあると見なされます。
DIAFILE_DIRS DIAFILE_DIRS タグは、ドキュメントに含まれる dia ファイル（\diafile コマンドを参照）を含む 1 つまたは複数のディレクトリを指定するために使用できます。
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 ファイル（\plantumlfile コマンドを参照）を含む 1 つまたは複数のディレクトリを指定するために使用できます。
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 ファイル（\mscfile コマンドを参照）を含む 1 つまたは複数のディレクトリを指定するために使用できます。
ソースファイル 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.13.0