設定
簡易設定
設定オプション一覧

外部リンク：Doxygen：Configuration (英語)

簡易設定

設定オプション
(Wizard)		トピックデフォルト値説明
全般
Step 1:Specify the working directory from which doxygen will runDoxygen の実行作業ディレクトリ
(各種ファイルを相対パス指定とする場合、ソースファイルのディレクトリが適当、それ以外は下記 INPUT を指定)
INPUT
(Wizard-Project-"Source code directory")		Input
Wizard		入力ソースファイル名・ディレクトリ名 (複数指定可)
省略：カレント(Doxygen の実行作業)ディレクトリ検索
サブディレクトリを検索させるには、RECURSIVE【入力ファイルのサブディレクトリ検索有無】を参照
DOXYFILE_ENCODINGProjectUTF-8設定ファイルのエンコード
例：UTF-8・CP932・SHIFT_JIS 等 (参考：libiconv)
INPUT_ENCODINGInputUTF-8ファイルのエンコード
(ソースファイル・挿入ファイル 等の設定)
例：UTF-8・CP932・SHIFT_JIS 等 (参考：libiconv)
例外は INPUT_FILE_ENCODING【個別ファイルのエンコード】1.9.5 で指定
OUTPUT_DIRECTORY
(Wizard-Project-"Destination directory")		Project
Wizard		出力ディレクトリ
OUTPUT_LANGUAGEProjectEnglish出力言語
⇒ Japanese・Japanese-en
PROJECT_NAME
(Wizard-Project-"Project name")		Project
Wizard		My Projectプロジェクト名
RECURSIVE
(Wizard-Project-Scan recursively)		Input
Wizard		NO入力ファイルのサブディレクトリ検索有無
複数ディレクトリを自動検索する場合は、YES に設定
個別指定は、INPUT【入力ソースファイル名・ディレクトリ名】を参照
開発言語 (Wizard からの設定が容易)
OPTIMIZE_～
CPP_CLI_SUPPORT
(Wizard-Mode-"Select programming language to optimize the result for") 		Project
Wizard		C++ 出力の最適化
指定開発言語
C++C++
C++/CLIC++/CLI
Java or C#Java・C#・Python
C or PHPC・PHP
FortranFortran
VHDLVHDL
出力形式 (Wizard からの設定が容易)
GENERATE_～
(Wizard-Output-"Select the output format(s) to generate") 		Output・HTML (Plain HTML)
・LaTeX (hyperlinked PDF) 		出力形式
指定出力形式
HTMLplain HTMLナビゲーションなしHTML
with navigation panelナビゲーションありHTML
prepare for compressed HTML (.chm)HTML Help
LaTeXhyperlinked PDFハイパーリンク付きPDF
PDFPDF
PostScriptPostScript
Man pagesMan pages
Rich Text Format (RTF)RTF
XMLXML
その他 (必要に応じて設定)
EXTRACT_ALL
(Wizard-Mode-"All Entities")		Build
Wizard		NO 有効コメントなし項目の詳細出力有無
YES の場合、WARNINGS【警告メッセージの出力有無】は無視されて出力なし
下記は有効
・EXTRACT_PRIVATE【プライベートメンバの出力有無】
・EXTRACT_STATIC【静的メンバの出力有無】

設定オプション一覧

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z ( Configuration (英語) )

設定オプション
(Wizard)		トピックデフォルト値説明
A
ABBREVIATE_BRIEFProject The $name class
The $name widget
The $name file
is
provides
specifies
contains
represents
a
an
the 		各種リスト概要の省略文字列 (複数指定可)
(概要の先頭が指定文字列の場合、指定文字列を省略し簡略化)
ALIASESProject エイリアス (複数指定可)
ユーザ定義コマンド(別名)を指定 (下記参照)
@if【条件付きコメント (if)】関連
@noop【無視コマンド】
@par【ユーザ定義 (段落)】
@xrefitem【ユーザ定義 (一覧)】
ALLEXTERNALSExternalNO全ての外部クラスの出力有無
(YES：全外部クラス出力 / NO：継承外部クラスのみ出力)
ALLOW_UNICODE_NAMESProjectNO出力ファイル名のUnicode使用有無
(NO：ASCII文字以外はエスケープ)
ALPHABETICAL_INDEXIndexYESクラス・構造体・共用体・インタフェース等のアルファベット順索引の生成有無
ALWAYS_DETAILED_SECProjectNO 詳細セクションの常時出力有無
(REPEAT_BRIEF も YES の場合、詳細がなくても詳細セクションを出力)
B
BINARY_TOCHTMLNOバイナリ形式の目次作成 (HTML Help ファイル)
BRIEF_MEMBER_DESCProjectYESファイル・クラスのメンバリストの概要出力有無 (Javadocに類似)
BUILTIN_STL_SUPPORTProjectNOSTL クラス(std::string・std::vector 等) 使用時にSTLソースを含めない
C
CALL_GRAPH
(Wizard-Diagrams-"Call graphs")		Dot
Wizard		NO 呼び出し関係図の生成有無
以下は個別指定で設定を無視 (図の表示例：以下参照)
・@callgraph【呼び出し関係図 (生成あり)】
・@hidecallgraph【呼び出し関係図 (生成なし)】
CALLER_GRAPH
(Wizard-Diagrams-"Called by graphs")		Dot
Wizard		NO 被呼び出し関係図の生成有無
以下は個別指定で設定を無視 (図の表示例：以下参照)
・@callergraph【被呼び出し関係図 (生成あり)】
・@hidecallergraph【被呼び出し関係図 (生成なし)】
CASE_SENSE_NAMESBuildシステム依存ファイルシステムの大文字・小文字の区別有無
CHM_FILEHTMLHTML Help ファイルのファイル名 (HTML Help ファイル)
CHM_INDEX_ENCODINGHTMLHTML Helpインデックス（hhk）・コンテンツ（hhc）・プロジェクトファイルコンテンツのエンコード (HTML Help ファイル)
例：UTF-8・CP932・SHIFT_JIS 等 (参考：libiconv)
CITE_BIB_FILESBuild参考文献定義 bib ファイル (要 BibTeX)
CLANG_ADD_INC_PATHS 1.9.1Source BrowserYES clang パーサ使用時のインクルードパス追加有無
CLANG_ASSISTED_PARSINGSource BrowserNO解析時の clang パーサの使用有無
CLANG_COMPILATION_DATABASE_PATH 1.8.14
CLANG_DATABASE_PATH 1.8.15 		Source Browserclang パーサ使用時のコンパイルデータベースのパス (compile_commands.json)
CLANG_OPTIONSSource Browserclang パーサ使用時のコマンドラインオプション
CLASS_DIAGRAMS 1.9.3
(Wizard-Diagrams-"Diagrams to generate")		Dot
Wizard		YES クラス図の生成有無 (dotツール未使用)
CLASS_GRAPHがYESの場合、無効
代替：CLASS_GRAPH【クラス図の生成有無】 と HAVE_DOT【dotツール使用有無】 で指定 1.9.3
CLASS_GRAPH
(Wizard-Diagrams-"Class diagrams")		Dot
Wizard		YES クラス図の生成有無 (dotツール使用 1.9.3 )
( HAVE_DOT【dotツール使用有無】で dotツールの使用有無を判断 1.9.3 )
NO：生成なし
YES：生成あり (dotツール)
TEXT：テキストとリンク
GRAPH：生成あり (組み込みジェネレータ)
COLLABORATION_GRAPH
(Wizard-Diagrams-"Collaboration diagrams")		Dot
Wizard		YES コラボレーション図(コミュニケーション図・連携図)の生成有無
以下は個別指定で設定を無視 (図の表示例：以下参照)
・@collaborationgraph【コラボレーション図の表示】1.9.8
・@hidecollaborationgraph【コラボレーション図の非表示】1.9.8
COLS_IN_ALPHA_INDEX 1.9.0Index5 アルファベット順索引の列数 (1～20)
参照：ALPHABETICAL_INDEX【索引の生成有無】
COMPACT_LATEXLaTeXNOコンパクトLaTeX出力有無 【LaTeX出力】
COMPACT_RTFRTFYESコンパクトRTF出力有無 【RTF出力】
CPP_CLI_SUPPORT
(Wizard-Mode-"Optimize for C++/CLI output")		Project
Wizard		NOC++/CLI のサポート有無
CREATE_SUBDIRSProjectNO 各出力形式の出力ディレクトリにサブディレクトリを作成
出力ファイルを4096の1.9.4 サブディレクトリに振り分け
サブディレクトリ数は、 CREATE_SUBDIRS_LEVEL【出力サブディレクトリ作成レベル数】で指定 1.9.4
(パフォーマンス対応)
CREATE_SUBDIRS_LEVEL 1.9.4Project8 出力ディレクトリのサブディレクトリ作成レベル数
(CREATE_SUBDIRS【出力サブディレクトリ作成有無】=YES の場合のみ有効)
(0：16個 ～ 8：4096個) 2 の (N + 4) 乗
D
DIAFILE_DIRSDotDiaファイルパス (複数指定可)
(参照：@diafile【Dia：図表ファイル挿入】)
DIA_PATHDotDia実行ファイルパス
(省略：DIAFILE_DIRS【Diaファイルパス (複数指定可)】を検索)
DIR_GRAPH_MAX_DEPTH 1.9.3Dot1 ディレクトリ依存関係図の子ディレクトリ最大レベル数
(DIRECTORY_GRAPH【ディレクトリ依存関係図の表示有無】＝YES の場合、有効)
(1 ～ 25)
DIRECTORY_GRAPHDotYES ディレクトリ依存関係図の表示有無
以下は個別指定で設定を無視 (図の表示例：以下参照)
・@directorygraph【ディレクトリ依存関係図の表示】1.9.8
・@hidedirectorygraph【ディレクトリ依存関係図の非表示】1.9.8
DISABLE_INDEXHTMLNO 上部インデックス無効化のオンオフ 【HTML出力】
(GENERATE_TREEVIEW【ナビの作成有無】がYESの場合に設定可能)
DISTRIBUTE_GROUP_DOCProjectNO最初のグループメンバドキュメントの再利用有無
DOCBOOK_OUTPUTDocbookdocbookDocBook出力ディレクトリ (相対パス：OUTPUT_DIRECTORY【出力ディレクトリ】からの相対) 【DocBook出力】
DOCBOOK_PROGRAMLISTING 1.9.2DocbookNO 【DocBook出力】
SOURCE_BROWSER【ソースファイルの埋め込み有無】に統合 1.9.2
DOCSET_BUNDLE_IDHTMLorg.doxygen.Project docsetバンドル (一意識別文字列) 【HTML-docset出力】
DOCSET_FEEDNAMEHTMLDoxygen generated docsdocsetフィード名 【HTML-docset出力】
DOCSET_FEEDURL 1.9.3HTML docsetフィードURL 【HTML-docset出力】
DOCSET_PUBLISHER_IDHTMLorg.doxygen.PublisherdocsetパブリッシャID (一意識別文字列) 【HTML-docset出力】
DOCSET_PUBLISHER_NAMEHTMLPublisherdocsetパブリッシャ名 【HTML-docset出力】
DOT_CLEANUPDotYESdot・msc ツールの中間ファイルの削除
DOT_COMMON_ATTR 1.9.5Dotfontname=Helvetica,fontsize=10 dotツールの共通属性
関連：
DOT_EDGE_ATTR【dotツールのエッジ属性】1.9.5
DOT_NODE_ATTR【dotツールのノード属性】1.9.5
参考： Graphviz Attributes
DOT_EDGE_ATTR 1.9.5Dotlabelfontname=Helvetica,labelfontsize=10 dotツールのエッジ属性
関連：
DOT_COMMON_ATTR【dotツールの共通属性】1.9.5
DOT_NODE_ATTR【dotツールのノード属性】1.9.5
参考： Graphviz Arrow Shapes
DOT_FONTNAME 1.9.5DotHelvetica dotツールのフォント名
⇒ DOT_COMMON_ATTR【dotツールの共通属性】1.9.5 で指定
DOT_FONTPATHDotdotツールのフォントパス
DOT_FONTSIZE 1.9.5Dot10 dotツールのフォントサイズ (4～24)
⇒ DOT_COMMON_ATTR【dotツールの共通属性】1.9.5 で指定
DOT_GRAPH_MAX_NODESDot50 dotツールの最大ノード数 (0～10000)
(MAX_DOT_GRAPH_DEPTH でも制限)
DOT_IMAGE_FORMATDotpngdotツール生成の画像フォーマット
DOT_MULTI_TARGETSDotNO dotツール(1.8.10以降)の同時ファイル出力有無
DOT_NODE_ATTR 1.9.5Dotshape=box,height=0.2,width=0.4 dotツールのノード属性
関連：
DOT_COMMON_ATTR【dotツールの共通属性】1.9.5
DOT_EDGE_ATTR【dotツールのエッジ属性】1.9.5
参考： Graphviz Node Shapes
DOT_NUM_THREADSDot0 (自動設定) dotツールの並行実行数 (0～32)
DOT_PATHDotdotツール(Graphvizの一部)のインストールパス
DOT_TRANSPARENT 1.9.5DotNO dotツールの透明背景の画像生成有無 (Windowsは未サポート)
DOT_UML_DETAILS 1.9.0DotNO UMLの詳細出力
NO：メンバ出力 (型・引数 なし)
YES：メンバ出力 (型・引数 あり)
NONE：メンバ出力なし
( UML_LOOK【UMLスタイル化】=YES の場合のみ有効)
DOT_WRAP_THRESHOLD 1.9.0Dot17 行折り返し文字数 (0～1000)
DOTFILE_DIRSDotDOTファイルパス (複数指定可)
(参照：@dotfile【DOT：ファイル挿入】)
DOXYFILE_ENCODINGProjectUTF-8設定ファイルのエンコード
例：UTF-8・CP932・SHIFT_JIS 等 (参考：libiconv)
E
ECLIPSE_DOC_IDHTMLorg.doxygen.ProjectEclipse help プラグインの一意識別子
ENABLED_SECTIONSBuild条件付きセクション
下記で判定
@cond【条件付きセクション (開始)】・@endcond【条件付きセクション (終了)】
@if【条件付きコメント (if)】・@ifnot【条件付きコメント (ifnot)】 ・@elseif【条件付きコメント (elseif)】
ENABLE_PREPROCESSINGPreprocessorYES ソース・インクルードファイルの全Cプリプロセッサディレクティブ評価の有無
ENUM_VALUES_PER_LINEHTML4(0～20)
EXAMPLE_PATHInput例ファイルパス
インクルードされるファイル名・ファイルパス (複数指定可)、下記で使用
@example【例 (ファイル)】
@dontinclude【コードブロック (ファイル・非表示)】
@include【コードブロック (ファイル)】
@includedoc【ファイル挿入 (コマンド有効)】
@includelineno【行番号付きコードブロック (ファイル)】
@snippet【コードブロック (ファイル指定部分)】
@snippetdoc【ファイル部分挿入 (コマンド有効)】
@snippetlineno【行番号付きコードブロック (ファイル指定部分)】
@verbinclude【テキストブロック (ファイル)】
@htmlinclude【HTML：ファイル挿入】
@latexinclude【LaTeX：ファイル挿入】
EXAMPLE_PATTERNSInput例ファイル名のワイルドカードパターン
EXAMPLE_RECURSIVEInputNO 例ファイルのサブディレクトリ検索有無 (@include【コードブロック (ファイル)】・@dontinclude【コードブロック (ファイル・非表示)】 で使用)
(YES：RECURSIVE【入力ファイルのサブディレクトリ検索有無】無視)
EXCLUDEInput INPUT【入力ソースファイル名・ディレクトリ名】から除外するファイル名・ディレクトリ名
EXCLUDE_PATTERNSInputINPUT【入力ソースファイル名・ディレクトリ名】のディレクトリから除外するワイルドカードパターン (test*.* 等)
EXCLUDE_SYMBOLSInput除外シンボル名 (名前空間・クラス・関数 など)
EXPAND_AS_DEFINEDPreprocessor
EXPAND_ONLY_PREDEFPreprocessorNO
EXTENSION_MAPPINGProjectファイル拡張子のマッピング
【ファイル拡張子】=【言語】
【ファイル拡張子】：拡張子なしは no_extension
参照：FILE_PATTERNS
EXTERNAL_GROUPSExternalYES
EXTERNAL_PAGESExternalYES
EXTERNAL_SEARCH_IDHTML
EXTERNAL_TOOL_PATH 1.12.0Build外部ツール検索パス拡張
一時的にPATH環境変数の先頭に指定パスを追加
EXTRACT_ALL
(Wizard-Mode-"All Entities")		Build
Wizard		NO 有効コメントなし項目の詳細出力有無
YES の場合、WARNINGS【警告メッセージの出力有無】は無視されて出力なし
下記は有効
・EXTRACT_PRIVATE【プライベートメンバの出力有無】
・EXTRACT_STATIC【静的メンバの出力有無】
EXTRACT_ANON_NSPACESBuildNO匿名名前空間メンバの出力有無
EXTRACT_LOCAL_CLASSESBuildYESローカル定義のクラス・構造体の出力有無
EXTRACT_LOCAL_METHODSBuildNOローカルメソッドの出力有無 【Objective-C】
EXTRACT_PACKAGEBuildNOパッケージ・内部スコープの全メンバの出力有無
EXTRACT_PRIVATEBuildNOクラスのプライベートメンバの出力有無
EXTRACT_PRIV_VIRTUAL 1.8.16BuildNO プライベート仮想メソッドの出力有無
EXTRACT_STATICBuildNO静的メンバの出力有無
EXTRA_PACKAGESLaTeX【LaTeX出力】
EXTRA_SEARCH_MAPPINGSHTML
F
FILE_PATTERNSInputINPUT【入力ソースファイル名・ディレクトリ名】のディレクトリ内のワイルドカードパターン (*.cpp 等)
FILE_VERSION_FILTERBuild
FILTER_PATTERNSInput
FILTER_SOURCE_FILESInputNO
FILTER_SOURCE_PATTERNSInput
FORCE_LOCAL_INCLUDESBuildNO <～> ではなく "～" でインクルードファイルをリスト
FORMULA_FONTSIZEHTML10 LaTeX 数式のフォントサイズ (8～50) 【HTML出力】
form_*.png ファイルの手動削除が必要
FORMULA_MACROFILE 1.8.17HTML
FORMULA_TRANSPARENT 1.9.5HTMLNO 数式イメージの透過 PNG 生成有無 【HTML出力】
form_*.png ファイルの手動削除が必要
FORTRAN_COMMENT_AFTER 1.9.5Input72 Fortran の自動コメントの開始位置 (7 ～ 10000)
FULL_PATH_NAMESProjectYES ファイルリストのファイル名のフルパス出力有無
参照：STRIP_FROM_PATH
FULL_SIDEBAR 1.9.2HTMLNO 左側ナビの全体使用 ( https://docs.readthedocs.io と同様の形式)
(GENERATE_TREEVIEW と DISABLE_INDEX が YES の場合のみ有効)
G
GENERATE_AUTOGEN_DEFAutoGenNO AutoGen定義ファイルの生成有無 (試験運用)
GENERATE_BUGLISTBuildYES @bug【バグ (一覧)】の一覧出力有無
GENERATE_CHIHTMLNO HTML Help用インデックスファイルの生成有無
(YES：.chi ファイル生成 / NO：.chm ファイルに含める)
(GENERATE_HTMLHELP が YES の場合のみ有効)
GENERATE_DEPRECATEDLISTBuildYES @deprecated【非推奨 (一覧)】の一覧出力有無
GENERATE_DOCBOOKDocbookNODocBook 出力有無
GENERATE_DOCSETHTMLNO Apple Xcode3統合開発環境用インデックスファイルの生成有無
(GENERATE_HTML が YES の場合のみ有効)
GENERATE_ECLIPSEHELPHTMLNOEclipse help プラグイン用インデックスファイルの生成有無
GENERATE_HTML
(Wizard-Output-"HTML")		HTML
Wizard		YESHTML 出力有無
GENERATE_HTMLHELP
(Wizard-Output-"HTML-prepare for compressed HTML (.chm)") 		HTML
Wizard		NO HTML Help 出力有無
GENERATE_LATEX
(Wizard-Output-"LaTeX")		LaTeX
Wizard		YESLaTeX 出力有無
GENERATE_LEGENDDotYES 凡例ページへのリンク生成 (dotツール未使用のクラス図)
GENERATE_MAN
(Wizard-Output-"Man pages")		Man
Wizard		NOman page 出力有無
GENERATE_PERLMODPerlModNOPerlモジュールファイルの生成有無 (試験運用)
GENERATE_QHPHTMLNO Qt Help用インデックスファイルの生成有無
(GENERATE_HTML が YES の場合のみ有効)
GENERATE_RTF
(Wizard-Output-"Rich Text Format (RTF)")		RTF
Wizard		NO Rich Text Format (RTF) 出力有無
GENERATE_SQLITE3 1.8.19NO シンボルのSQLite3データベース作成有無
GENERATE_TAGFILEExternal外部ドキュメント用タグファイル作成名
GENERATE_TESTLISTBuildYES @test【テストケース (一覧)】の一覧出力有無
GENERATE_TODOLISTBuildYES @todo【TODO (一覧)】の一覧出力有無
GENERATE_TREEVIEW
(Wizard-Output-"HTML-with navigation panel")		HTML
Wizard		NO 左側ナビの作成有無 【HTML出力】
(YESの場合にDISABLE_INDEX【上部インデックスの無効化】が設定可能)
左側ナビに絵文字表示可 (例：ページ内の@section【セクション】等のタイトル) 1.11.0
GENERATE_XML
(Wizard-Output-"XML")		XML
Wizard		NOXML 出力有無
GRAPHICAL_HIERARCHY
(Wizard-Diagrams-"Overall Class hierrchy")		Dot
Wizard		YES 全体のクラス階層図の生成有無
GROUP_GRAPHSDotYES グループ依存関係図の表示有無
以下は個別指定で設定を無視 (図の表示例：以下参照)
・@groupgraph【グループ依存関係図の表示】1.9.8
・@hidegroupgraph【グループ依存関係図の非表示】1.9.8
GROUP_NESTED_COMPOUNDSProjectNO入れ子のクラス・構造体の同一グループ追加有無
H
HAVE_DOT
(Wizard-Diagrams-"Use dot tool from the GraphViz package")		Dot
Wizard		NO dotツール(Graphvizの一部)の使用有無
HHC_LOCATIONHTML
HIDE_COMPOUND_REFERENCEBuildNO ページタイトル部分の追加文言の非表示 (例：クラスページの"クラス")
HIDE_FRIEND_COMPOUNDSBuildNOfriend（class | struct | union）宣言を非表示
HIDE_IN_BODY_DOCSBuildNO関数内ドキュメントの非表示
HIDE_SCOPE_NAMESBuildNOフルクラスと名前空間のスコープを持つメンバを非表示
HIDE_UNDOC_CLASSESBuildNO有効コメントなしクラスをクラス階層で非表示
HIDE_UNDOC_MEMBERSBuildNOクラス・ファイルの有効コメントなしメンバを非表示
HIDE_UNDOC_RELATIONSDotYES クラス図・コラボレーション図で未記述のクラス等を非表示
HTML_CODE_FOLDING 1.9.8HTMLYES ソースコード折りたたみ機能有無【HTML出力】
クラス・関数等の折りたたみと展開
HTML_COLORSTYLE 1.9.5HTMLAUTO_LIGHT カラースタイル【HTML出力】
指定値備考
LIGHTライトモード
DARKダークモード
AUTO_LIGHT自動ライトモード (ブラウザ設定と同期 / 設定なし：ライトモード)
AUTO_DARK自動ダークモード (ブラウザ設定と同期 / 設定なし：ダークモード)
TOGGLEライトモード・ダークモードの切り替え可
HTML_COLORSTYLE_GAMMA
(Wizard-Output-"HTML [Change color...]") 		HTML
Wizard		80ガンマ補正 [40～240] 【HTML出力】
HTML_COLORSTYLE_HUE
(Wizard-Output-"HTML [Change color...]")		HTML
Wizard		220 色相 [0～359] 【HTML出力】
HTML_COLORSTYLE_SAT
(Wizard-Output-"HTML [Change color...]")		HTML
Wizard		100 彩度 [0～255] 【HTML出力】
HTML_COPY_CLIPBOARD 1.10.0HTMLYES コード・テキストのクリップボードコピー用アイコン表示有無 【HTML出力】
(安全な場合のみ機能：https:・file: プロトコル)
HTML_DYNAMIC_MENUSHTMLYES上部インデックスの動的メニュー 【HTML出力】
HTML_DYNAMIC_SECTIONSHTMLNO開閉可能セクションの有効化 (クラス図等) 【HTML出力】
HTML_EXTRA_FILESHTML出力ディレクトリにコピーする必要がある画像ファイル・その他ソースファイル 【HTML出力】
HTML_EXTRA_STYLESHEETHTML ユーザー定義の追加CSS 【HTML出力】
(出力ディレクトリにコピー)
HTML_FILE_EXTENSIONHTML.html 出力ページのファイル拡張子 (例：.htm・.php・.asp) 【HTML出力】
HTML_FORMULA_FORMAT 1.8.18HTMLpng 数式の出力画像 【HTML出力】
画像備考
pngPNG 画像
svg SVG 画像  (pdf2svg  または inkscape が必要)
HTML_HEADERHTMLユーザー定義のヘッダ部HTMLファイル 【HTML出力】
(doxygen -w html でテンプレートファイル作成可  Fine-tuning the output )
下記マーカーが使用可
マーカー備考
$titleページタイトル
$datetime現在日時
$date現在日付
$year現在年
$doxygenversionDoxygenのバージョン
$projectnameプロジェクト名 (参照：PROJECT_NAME)
$projectnumberプロジェクト番号 (参照：PROJECT_NUMBER)
$projectbriefプロジェクトの概要 (参照：PROJECT_BRIEF)
$projectlogoプロジェクトロゴ (参照：PROJECT_LOGO)
$treeviewナビゲーションツリー
$search検索ボックス
$mathjaxMathJax用JavaScript・スタイルシート
$relpath^HTML出力ディレクトリへの相対パス
HTML_INDEX_NUM_ENTRIESHTML100[0～9999] 【HTML出力】
HTML_OUTPUTHTMLhtmlHTML出力ディレクトリ (相対パス：OUTPUT_DIRECTORY【出力ディレクトリ】からの相対) 【HTML出力】
HTML_STYLESHEETHTML ユーザー定義のCSS 【HTML出力】 非推奨/廃止予定 HTML_EXTRA_STYLESHEET 参照
HTML_TIMESTAMP 1.9.7HTMLNO フッタのページ生成日時の挿入有無【HTML出力】
代替：TIMESTAMP【ページ生成日時の挿入形式】1.9.7
I
IDL_PROPERTY_SUPPORTProjectYES IDL プロパティのサポート有無
(propget・propput 属性を get・set メソッドに置き換え)
IGNORE_PREFIXIndex索引で無視するプレフィックス (複数指定可)
(同一プレフィックスが偏る場合に指定)
参照：ALPHABETICAL_INDEX【索引の生成有無】
IMAGE_PATHInput 画像ファイルパス (複数指定可)
@image【画像】
INCLUDE_FILE_PATTERNSPreprocessor
INCLUDE_GRAPH
(Wizard-Diagrams-"Include dependency graphs")		Dot
Wizard		YES ファイルのインクルード関係図 (依存先関係図)
(ENABLE_PREPROCESSING および SEARCH_INCLUDES が YES の場合)
以下は個別指定で設定を無視 (図の表示例：以下参照)
・@includegraph【ファイルのインクルード関係図の表示】1.9.8
・@hideincludegraph【ファイルのインクルード関係図の非表示】1.9.8
INCLUDE_PATHPreprocessor インクルードファイルのパス
(SEARCH_INCLUDES が YES の場合に使用)
INCLUDED_BY_GRAPH
(Wizard-Diagrams-"Included by dependency graphs")		Dot
Wizard		YES ファイルの被インクルード関係図 (被依存関係図)
(ENABLE_PREPROCESSING および SEARCH_INCLUDES が YES の場合)
以下は個別指定で設定を無視 (図の表示例：以下参照)
・@includedbygraph【ファイルの被インクルード関係図の表示】1.9.8
・@hideincludedbygraph【ファイルの被インクルード関係図の非表示】1.9.8
INHERIT_DOCSProjectYESコメントがないメンバは継承元からドキュメントを継承
INLINE_GROUPED_CLASSESProjectNOクラス・構造体・共用体をグループにまとめて出力
INLINE_INFOBuildYESインラインメンバに[inline]タグの挿入有無
INLINE_INHERITED_MEMBProjectNO 継承メンバの出力有無
(基本クラスのコンストラクタ・デストラクタ・代入演算子は対象外)
INLINE_SIMPLE_STRUCTSProjectNO パブリックデータフィールド・単純typedefフィールドのみの構造体・クラス・共用体のインライン出力有無
INLINE_SOURCESSource BrowserNO関数・クラス・列挙体の本体をインラインで挿入 (不備あり)
INPUT
(Wizard-Project-"Source code directory")		Input
Wizard		入力ソースファイル名・ディレクトリ名 (複数指定可)
省略：カレント(Doxygen の実行作業)ディレクトリ検索
サブディレクトリを検索させるには、RECURSIVE【入力ファイルのサブディレクトリ検索有無】を参照
INPUT_ENCODINGInputUTF-8ファイルのエンコード
(ソースファイル・挿入ファイル 等の設定)
例：UTF-8・CP932・SHIFT_JIS 等 (参考：libiconv)
例外は INPUT_FILE_ENCODING【個別ファイルのエンコード】1.9.5 で指定
INPUT_FILE_ENCODING 1.9.5個別ファイルのエンコード
INPUT_ENCODING【ファイルのエンコード】の例外を指定
(例：*.txt=SHIFT_JIS)
INPUT_FILTERInput 入力ファイルのフィルタリング用プログラム
(FILTER_PATTERNSが指定されている場合は無効)
INTERACTIVE_SVGDotNO インタラクティブSVG画像の生成
(一定サイズ以上でズーム・パン可能)
参照：DOT_IMAGE_FORMAT【dotツール生成の画像フォーマット】
INTERNAL_DOCSBuildNO 内部文書の表示有無
参照：@internal・@endinternal【内部文書】
J・K
JAVADOC_AUTOBRIEFProjectNO Javadocスタイルのコメント (/** ～ */)での先頭行のコマンド省略の扱い
YES：@brief【概要】として処理 (Javadocスタイル)
NO：@details【詳細】として処理
関連： JAVADOC_BANNER ・QT_AUTOBRIEF ・MULTILINE_CPP_IS_BRIEF ・REPEAT_BRIEF
JAVADOC_BANNER 1.8.16ProjectNO Javadocスタイルのバナーコメント (/**～**)の扱い
YES：ドキュメントコメントとして処理
NO：通常コメントとして処理
関連： JAVADOC_AUTOBRIEF
L
LATEX_BATCHMODE 1.9.7LaTeXNO エラー時のLaTeX動作【LaTeX出力】
NO：エラー毎に入力待ち
YES：実行継続
BATCH：実行継続 (YESと同等) 1.9.7
NON_STOP：実行継続 (診断メッセージ表示) 1.9.7
SCROLL：ファイル欠落・要入力の場合、入力待ち 1.9.7
ERROR_STOP：エラー毎に入力待ち (NOと同等) 1.9.7
LATEX_BIB_STYLELaTeXplain 参考文献の使用スタイル (例：plainnat・ieeetr 等) 【LaTeX出力】
LATEX_CMD_NAMELaTeXlatex【LaTeX出力】
LATEX_EMOJI_DIRECTORY 1.8.15LaTeX 絵文字画像の読み取り元パス (相対または絶対) 【LaTeX出力】
相対パス：LATEX_OUTPUT【LaTeX出力ディレクトリ】からの相対
省略：LATEX_OUTPUT【LaTeX出力ディレクトリ】
LATEX_EXTRA_FILESLaTeX 出力ディレクトリにコピーする必要がある画像ファイル・その他ソースファイル 【LaTeX出力】
LATEX_EXTRA_STYLESHEETLaTeXユーザー定義の追加CSS 【LaTeX出力】
(出力ディレクトリにコピー)
LATEX_HEADERLaTeXユーザー定義のヘッダ部TeXファイル 【LaTeX出力】
LATEX_HIDE_INDICESLaTeXNO【LaTeX出力】
LATEX_MAKEINDEX_CMD 1.8.15LaTeX\makeindex【LaTeX出力】
LATEX_OUTPUTLaTeXlatexLaTeX出力ディレクトリ (相対パス：OUTPUT_DIRECTORY【出力ディレクトリ】からの相対) 【LaTeX出力】
LATEX_SOURCE_CODE 1.9.2LaTeXNO 【LaTeX出力】
SOURCE_BROWSER【ソースファイルの埋め込み有無】に統合 1.9.2
LATEX_TIMESTAMP 1.9.7LaTeXNO フッタのページ生成日時の挿入有無【LaTeX出力】
代替：TIMESTAMP【ページ生成日時の挿入形式】1.9.7
LAYOUT_FILEBuild空
(DoxygenLayout.xml)		レイアウトファイル
LOOKUP_CACHE_SIZEProject0 シンボルルックアップキャッシュのサイズ (0～9)
実行後に使用状況のレポート出力
(キャッシュサイズ：2^(16 + LOOKUP_CACHE_SIZE))
M
MACRO_EXPANSIONPreprocessorNO
MAKEINDEX_CMD_NAMELaTeXmakeindex【LaTeX出力】
MAN_EXTENSIONMan3【man page出力】
MAN_OUTPUTManmanman page出力ディレクトリ (相対パス：OUTPUT_DIRECTORY【出力ディレクトリ】からの相対) 【man page出力】
MAN_SUBDIRMan【man page出力】
MARKDOWN_ID_STYLE 1.9.7ProjectDOXYGEN マークダウンの見出し id スタイル
DOXYGEN (Doxygen スタイル)：'autotoc_md'＋シーケンス番号 (0～)
GITHUB (GitHub スタイル)：タイトル文字列を小文字にし、空白を'-'に置換、句読点を削除
(MARKDOWN_SUPPORT【マークダウンのサポート有無】=YES で有効)
MARKDOWN_SUPPORTProjectYESマークダウンのサポート有無
MATHJAX_CODEFILEHTML
MATHJAX_EXTENSIONSHTML
MATHJAX_FORMATHTMLHTML-CSS(NativeMML・SVG)
MATHJAX_RELPATHHTMLhttp://cdn.mathjax.org/mathjax/latest
MATHJAX_VERSION 1.9.2HTMLMathJax_2使用 MathJax バージョン
MAX_DOT_GRAPH_DEPTHDot0 dotツールの最大深度 (0～1000)
(DOT_GRAPH_MAX_NODES でも制限)
MAX_INITIALIZER_LINESBuild30 (0～10000)
MSCFILE_DIRSDotmscファイルパス (複数指定可)
MSCGEN_PATH 1.8.16
(組み込み 1.8.16 ) 		DotMscgen実行ファイルパス
(省略：MSCFILE_DIRS【mscファイルパス (複数指定可)】を検索)
MSCGEN_TOOL 1.9.7DotMSG【メッセージシーケンスチャート】の外部作成ツール
' -T -o' オプションで実行 ('png'・'eps'・'svg'・'ismap' 形式のサポートが必要)
(未指定：組み込みMscgenツール使用)
MULTILINE_CPP_IS_BRIEFProjectNO C++スタイルのコメント (//!・///)での先頭行のコマンド省略の扱い
YES：@brief【概要】として処理
NO：@details【詳細】として処理
関連： JAVADOC_AUTOBRIEF ・QT_AUTOBRIEF ・REPEAT_BRIEF
N
NUM_PROC_THREADS 1.8.19Project1使用スレッド数 (0：自動設定 / 1～32) 試験運用
O
OBFUSCATE_EMAILS 1.9.3HTMLYES メールアドレスの難読化の有無
OPTIMIZE_FOR_FORTRAN
(Wizard-Mode-"Optimize for Fortran output")		Project
Wizard		NO Fortran のソースでのみ構成されている場合の出力最適化の有無
OPTIMIZE_OUTPUT_FOR_C
(Wizard-Mode-"Optimize for C or PHP output")		Project
Wizard		NO C のソースでのみ構成されている場合の出力最適化の有無
OPTIMIZE_OUTPUT_JAVA
(Wizard-Mode-"Optimize for Java or C# output")		Project
Wizard		NO Java または C# またはPython のソースでのみ構成されている場合の出力最適化の有無
OPTIMIZE_OUTPUT_SLICE 1.8.15ProjectNO Slice のソースでのみ構成されている場合の出力最適化の有無
OPTIMIZE_OUTPUT_VHDL
(Wizard-Mode-"Optimize for VHDL output")		Project
Wizard		NO VHDL のソースでのみ構成されている場合の出力最適化の有無
OUTPUT_DIRECTORY
(Wizard-Project-"Destination directory")		Project
Wizard		出力ディレクトリ
OUTPUT_LANGUAGEProjectEnglish出力言語
⇒ Japanese・Japanese-en
OUTPUT_TEXT_DIRECTION 1.8.151.9.2 ProjectNone 出力のテキスト方向 (None・LTR・RTL・Context)
P
PAPER_TYPELaTeXa4(a4・letter・legal・executive) 【LaTeX出力】
PERLMOD_LATEXPerlModNO
PERLMOD_MAKEVAR_PREFIXPerlMod
PERLMOD_PRETTYPerlModYES
PERL_PATH 1.8.16External/usr/bin/perl
PLANTUML_CFG_FILEDot PlantUMLの設定ファイル
参照：図の生成・挿入
PLANTUML_INCLUDE_PATHDot PlantUMLのインクルードファイルのパス (複数指定可)
(!include ステートメントの検索パス)
参照：図の生成・挿入
PLANTUML_JAR_PATHDot plantuml.jar ファイルのパス
参照：図の生成・挿入
PREDEFINEDPreprocessor
PROJECT_BRIEF
(Wizard-Project-"Project synopsis")		Project
Wizard 		プロジェクトの概要
PROJECT_ICON 1.10.0Project プロジェクト アイコン 【HTML出力】
(タブ表示のアイコン)
PROJECT_NAME
(Wizard-Project-"Project name")		Project
Wizard		My Projectプロジェクト名
PROJECT_NUMBER
(Wizard-Project-"Project version or id")		Project
Wizard 		プロジェクト番号
PYTHON_DOCSTRING 1.8.20ProjectYES Python  ドキュメンテーション文字列(''') の標準ドキュメントとしての使用有無
YES：Pythonの標準ドキュメントとして使用
NO：Doxygenのコメントとして使用
Q
QCH_FILEHTML
QHG_LOCATIONHTML
QHP_CUST_FILTER_ATTRSHTML
QHP_CUST_FILTER_NAMEHTML
QHP_NAMESPACEHTMLorg.doxygen.Project
QHP_SECT_FILTER_ATTRSHTML
QHP_VIRTUAL_FOLDERHTMLdoc
QT_AUTOBRIEFProjectNO Qtスタイルのコメント (/*! ～ */)での先頭行のコマンド省略の扱い
YES：@brief【概要】として処理
NO：@details【詳細】として処理 (Qtスタイル)
関連： JAVADOC_AUTOBRIEF ・MULTILINE_CPP_IS_BRIEF ・REPEAT_BRIEF
QUIETMessagesNO標準出力メッセージの出力なし
R
RECURSIVE
(Wizard-Project-Scan recursively)		Input
Wizard		NO入力ファイルのサブディレクトリ検索有無
複数ディレクトリを自動検索する場合は、YES に設定
個別指定は、INPUT【入力ソースファイル名・ディレクトリ名】を参照
REFERENCED_BY_RELATIONSource BrowserNO参照元の表示有無
REFERENCES_RELATIONSource BrowserNO参照先の表示有無
REPEAT_BRIEFProjectYES メンバ・関数詳細の前に概要の出力有無
関連：@brief【概要】 ・JAVADOC_AUTOBRIEF ・QT_AUTOBRIEF ・MULTILINE_CPP_IS_BRIEF
RESOLVE_UNNAMED_PARAMS 1.9.0BuildYES
RTF_EXTENSIONS_FILERTFRTFオプション変数ファイル 【RTF出力】
RTF_EXTRA_FILES 1.11.0RTF出力ディレクトリにコピーする必要がある画像ファイル・その他ソースファイル 【RTF出力】
RTF_OUTPUTRTFrtfRTF出力ディレクトリ (相対パス：OUTPUT_DIRECTORY【出力ディレクトリ】からの相対) 【RTF出力】
RTF_SOURCE_CODE 1.9.2RTFNO 【RTF出力】
SOURCE_BROWSER【ソースファイルの埋め込み有無】に統合 1.9.2
RTF_STYLESHEET_FILERTFRTF用スタイルシート ファイル 【RTF出力】
S
SEARCHDATA_FILEHTMLsearchdata.xml
SEARCHENGINE
(Wizard-Output-"HTML-With search function")		HTML
Wizard		YES 検索ボックスの作成有無 【HTML出力】
SEARCHENGINE_URLHTML(なし)
付属検索エンジン		外部検索エンジン 【HTML出力】
SEARCH_INCLUDESPreprocessorYES INCLUDE_PATH 内のインクルードファイル検索有無
SEPARATE_MEMBER_PAGESProjectNOメンバ毎のページの生成有無
SHORT_NAMESProjectNO 短いファイル名のファイル生成有無
(長いファイル名の未サポート環境で有用)
SHOW_ENUM_VALUES 1.12.0HTMLNO 列挙値の表示有無 (明示的な値設定のみ有効)
関連：
@enum【列挙型】
@showenumvalues【列挙値の表示】・@hideenumvalues【列挙値の非表示】
SHOW_FILESBuildYESファイルページの表示有無
SHOW_GROUPED_MEMB_INCBuildNOグループ化メンバ毎のインクルードファイル表示有無
SHOW_HEADERFILE 1.9.2BuildYES クラスに必要なファイル表示有無
SHOW_INCLUDE_FILESBuildYESファイルページのインクルードファイル表示有無
SHOW_NAMESPACESBuildYES名前空間ページの表示有無
SHOW_USED_FILESBuildYESクラス・構造体の使用ファイルリストの表示有無
SIP_SUPPORTProjectNO SIP のサポート有無
(明示的なアクセス修飾子がないクラスをpublic 指定)
SITEMAP_URL 1.9.7HTML  サイトマップ作成時のサーバー配置場所のURL
指定時、HTML_OUTPUT【HTML 出力ディレクトリ】に sitemap.xml として出力
(GENERATE_HTML が YES の場合のみ有効)
SKIP_FUNCTION_MACROSPreprocessorYES
SORT_BRIEF_DOCSBuildNO
SORT_BY_SCOPE_NAMEBuildNO
SORT_GROUP_NAMESBuildNO
SORT_MEMBERS_CTORS_1STBuildNO
SORT_MEMBER_DOCSBuildYES
SOURCE_BROWSER
(Wizard-Mode-"Include cross-referenced source code in the output") 		Source Browser
Wizard		NO ソースファイルの埋め込み有無
(相互参照可能)
参照：VERBATIM_HEADERS
SOURCE_TOOLTIPSSource Browserソースファイル内ハイパーリンクのツールチップ表示有無
SQLITE3_OUTPUT 1.8.19Sqlite3sqlite3SQLite3データベース出力ディレクトリ (相対パス：OUTPUT_DIRECTORY【出力ディレクトリ】からの相対)
SQLITE3_RECREATE_DB 1.8.19YES
STRICT_PROTO_MATCHINGBuildNO
STRIP_CODE_COMMENTSSource BrowserYES ソースコードからDoxygenコマンドのコメントを非表示
STRIP_FROM_INC_PATHProjectクラス使用のヘッダファイルの除去パス (複数指定可)
STRIP_FROM_PATHProjectファイルリストの除去パス (複数指定可・相対パス指定可)
省略：Doxygen実行ディレクトリ
参照：FULL_PATH_NAMES
SUBGROUPINGProjectYES同タイプのクラスメンバーグループをサブグループ化の有無
T
TAB_SIZEProject4タブサイズ (1～16)
TAGFILESExternal外部ドキュメントのタグファイル
TCL_SUBST 1.8.18Project 単語・キーワードのマッピング指定 (複数指定可・Tclのみ)
TEMPLATE_RELATIONSDotNO クラス図・コラボレーション図にテンプレートとインスタンスの関係を表示
TIMESTAMP 1.9.7ProjectNO ページ生成日時の挿入形式
YES：挿入あり (日時形式)
NO：挿入なし
DATETIME：日時形式
DATE：日付形式
TOC_EXPANDHTMLNO
TOC_INCLUDE_HEADINGSProject0 マークダウンの見出しをidなしでも目次出力するレベル (0～99)
TREEVIEW_WIDTHHTML250左側ナビの初期幅 (0～1500 ピクセル)【HTML出力】
TYPEDEF_HIDES_STRUCTProjectNO 構造体・共用体・列挙型のtypedefを構造体等として出力
(NO：名前空間・クラスのメンバとして出力)
U
UML_LIMIT_NUM_FIELDSDot10 UMLスタイルのフィールド数のしきい値 (0～100)
しきい値の150%までは全て表示、超えるとしきい値まで表示
参照：UML_LOOK
UML_LOOKDotNOクラス図・コラボレーション図のUMLスタイル化
USE_HTAGSSource BrowserNO
USE_MATHJAXHTMLNOMathJaxの使用有無 (LaTeXのHTML出力)
USE_MDFILE_AS_MAINPAGEInput メインページ (index.html) として使用するマークダウンファイル名
USE_PDFLATEX
(Wizard-LaTeX-"as intermediate format for PDF")		LaTeX
Wizard		YES 【LaTeX出力】
V
VERBATIM_HEADERSSource BrowserYES クラス用インクルードファイルの埋め込み有無
参照：SOURCE_BROWSER【ソースファイルの埋め込み有無】
W
WARNINGSMessagesYES標準エラー（stderr）の警告メッセージの出力有無
WARN_AS_ERRORMessagesNO警告時の停止有無
WARN_FORMATMessages$file:$line: $text警告メッセージの形式
WARN_IF_DOC_ERRORMessagesYES潜在的エラーの警告有無
WARN_IF_INCOMPLETE_DOC 1.9.2MessagesYES ドキュメント無し関数引数の警告有無
WARN_IF_UNDOCUMENTEDMessagesYES ドキュメント無しメンバの警告有無
EXTRACT_ALL が YES の場合、自動的に NO
WARN_IF_UNDOC_ENUM_VAL 1.9.6MessagesNO ドキュメント無し列挙子の警告有無
EXTRACT_ALL が YES の場合、自動的に NO
WARN_LINE_FORMAT 1.9.4Messagesat line $line of file $file WARN_FORMAT【警告メッセージ形式】の $text 部分がジャンプ可能な場合の形式
WARN_LOGFILEMessages 警告・エラー メッセージの書き込みファイル
省略：標準エラー (stderr)
WARN_NO_PARAMDOCMessagesNOドキュメント無し引数・戻り値の警告有無
X・Y・Z
XML_NS_MEMB_FILE_SCOPE 1.8.15XMLNO【XML出力】
XML_OUTPUTXMLxmlXML出力ディレクトリ (相対パス：OUTPUT_DIRECTORY【出力ディレクトリ】からの相対) 【XML出力】
XML_PROGRAMLISTINGXMLYES【XML出力】