設定

簡易設定

設定オプション
(Wizard)
トピックデフォルト値説明
全般
Step 1:Specify the working directory from which doxygen will runDoxygen の実行作業ディレクトリ
(各種ファイルを相対パス指定とする場合、ソースファイルのディレクトリが適当、それ以外は下記 INPUT を指定)
INPUT
(Wizard-Project-"Source code directory")
Input
Wizard
入力ソースファイル名・ディレクトリ名 (複数指定可)
省略:カレント(Doxygen の実行作業)ディレクトリ検索
DOXYFILE_ENCODINGProjectUTF-8設定ファイルのエンコード
例:UTF-8・CP932・SHIFT_JIS 等 (参考:libiconv)
INPUT_ENCODINGInputUTF-8ファイルのエンコード
(ソースファイル・挿入ファイル 等の設定)
例:UTF-8・CP932・SHIFT_JIS 等 (参考:libiconv)
OUTPUT_DIRECTORY
(Wizard-Project-"Destination directory")
Project
Wizard
出力ディレクトリ
OUTPUT_LANGUAGEProjectEnglish出力言語
Japanese・Japanese-en
PROJECT_NAME
(Wizard-Project-"Project name")
Project
Wizard
My Projectプロジェクト名
開発言語 (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

設定オプション一覧

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エイリアス (複数指定可)
ALLEXTERNALSExternalNO
ALLOW_UNICODE_NAMESProjectNO出力ファイル名のUnicode使用有無
(NO:ASCII文字以外はエスケープ)
ALPHABETICAL_INDEXIndexYESクラス・構造体・共用体・インタフェース等のアルファベット順索引の生成有無
ALWAYS_DETAILED_SECProjectNO 詳細セクションの常時出力有無
(REPEAT_BRIEF も YES の場合、詳細がなくても詳細セクションを出力)
B
BINARY_TOCHTMLNO
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_NAMESBuildNOファイル名の大文字・小文字混在表示有無
CHM_FILEHTMLHTML Help ファイルのファイル名 (HTML Help ファイル)
CHM_INDEX_ENCODINGHTMLHTML Helpインデックス(hhk)・コンテンツ(hhc)・プロジェクトファイルコンテンツのエンコード (HTML Help ファイル)
例:UTF-8・CP932・SHIFT_JIS 等 (参考:libiconv)
CITE_BIB_FILESBuild
CLANG_ASSISTED_PARSINGSource BrowserNO
CLANG_COMPILATION_DATABASE_PATHSource Browser
CLANG_OPTIONSSource Browser
CLASS_DIAGRAMS
(Wizard-Diagrams-"Diagrams to generate")
Dot
Wizard
YES クラス図の生成有無 (dotツール未使用)
CLASS_GRAPHがYESの場合、無効
CLASS_GRAPH
(Wizard-Diagrams-"Class diagrams")
Dot
Wizard
YES クラス図の生成有無 (dotツール使用)
COLLABORATION_GRAPH
(Wizard-Diagrams-"Collaboration diagrams")
Dot
Wizard
YES コラボレーション図の生成有無
COLS_IN_ALPHA_INDEXIndex5 アルファベット順索引の列数 (1~20)
参照:ALPHABETICAL_INDEX【索引の生成有無】
COMPACT_LATEXLaTeXNO【LaTeX出力】
COMPACT_RTFRTFYES【RTF出力】
CPP_CLI_SUPPORT
(Wizard-Mode-"Optimize for C++/CLI output")
Project
Wizard
NOC++/CLI のサポート有無
CREATE_SUBDIRSProjectNO 各出力形式の出力ディレクトリにサブディレクトリを作成
出力ファイルを4096のサブディレクトリに振り分け
(パフォーマンス対応)
D
DIAFILE_DIRSDotDiaファイルパス (複数指定可)
(参照:@diafile【Dia:図表ファイル挿入】)
DIA_PATHDotDia実行ファイルパス (省略:検索パス)
DIRECTORY_GRAPHDotYES ディレクトリの依存関係のグラフィカル表示有無
DISABLE_INDEXHTMLNO 上部インデックス無効化のオンオフ 【HTML出力】
(GENERATE_TREEVIEW【ナビの作成有無】がYESの場合に設定可能)
DISTRIBUTE_GROUP_DOCProjectNO最初のグループメンバドキュメントの再利用有無
DOCBOOK_OUTPUTDocbookdocbook【DocBook出力】
DOCBOOK_PROGRAMLISTINGDocbookNO【DocBook出力】
DOCSET_BUNDLE_IDHTMLorg.doxygen.Project
DOCSET_FEEDNAMEHTMLDoxygen generated docs
DOCSET_PUBLISHER_IDHTMLorg.doxygen.Publisher
DOCSET_PUBLISHER_NAMEHTMLPublisher
DOT_CLEANUPDotYESdotツールの中間ファイルの削除
DOT_FONTNAMEDotHelveticadotツールのフォント名
DOT_FONTPATHDotdotツールのフォントパス
DOT_FONTSIZEDot10dotツールのフォントサイズ (4~24)
DOT_GRAPH_MAX_NODESDot50 dotツールの最大ノード数 (0~10000)
(MAX_DOT_GRAPH_DEPTH でも制限)
DOT_IMAGE_FORMATDotpngdotツール生成の画像フォーマット
DOT_MULTI_TARGETSDotNOdotツール(1.8.10以降)の同時ファイル出力有無
DOT_NUM_THREADSDot0 (自動設定)dotツールの並行実行数 (0~32)
DOT_PATHDotdotツール(Graphvizの一部)のインストールパス
DOT_TRANSPARENTDotNOdotツールの透明背景の画像生成有無 (Windowsは未サポート)
DOTFILE_DIRSDotDOTファイルパス (複数指定可)
(参照:@dotfile【DOT:ファイル挿入】)
DOXYFILE_ENCODINGProjectUTF-8設定ファイルのエンコード
例:UTF-8・CP932・SHIFT_JIS 等 (参考:libiconv)
E
ECLIPSE_DOC_IDHTMLorg.doxygen.Project
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
EXCLUDEInputINPUT【入力ソースファイル名・ディレクトリ名】から除外するファイル名・ディレクトリ名
EXCLUDE_PATTERNSInputINPUT【入力ソースファイル名・ディレクトリ名】のディレクトリから除外するワイルドカードパターン (test*.* 等)
EXCLUDE_SYMBOLSInput
EXPAND_AS_DEFINEDPreprocessor
EXPAND_ONLY_PREDEFPreprocessorNO
EXTENSION_MAPPINGProjectファイル拡張子のマッピング
【ファイル拡張子】=【言語】
【ファイル拡張子】:拡張子なしは no_extension
参照:FILE_PATTERNS
EXTERNAL_GROUPSExternalYES
EXTERNAL_PAGESExternalYES
EXTERNAL_SEARCH_IDHTML
EXTRACT_ALL
(Wizard-Mode-"All Entities")
Build
Wizard
NO 有効コメントなし項目の詳細出力有無
WARNINGS【警告メッセージの出力有無】は無視されて出力なし
下記は有効
EXTRACT_PRIVATE【プライベートメンバの出力有無】
EXTRACT_STATIC【静的メンバの出力有無】
EXTRACT_ANON_NSPACESBuildNO匿名名前空間メンバの出力有無
EXTRACT_LOCAL_CLASSESBuildYESローカル定義のクラス・構造体の出力有無
EXTRACT_LOCAL_METHODSBuildNOローカルメソッドの出力有無 【Objective-C】
EXTRACT_PACKAGEBuildNOパッケージ・内部スコープの全メンバの出力有無
EXTRACT_PRIVATEBuildNOクラスのプライベートメンバの出力有無
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_FONTSIZEHTML10LaTeX 数式のフォントサイズ (8~50) 【HTML出力】
form_*.png ファイルの手動削除が必要
FORMULA_TRANSPARENTHTMLNO数式イメージの透過 PNG 生成有無 【HTML出力】
form_*.png ファイルの手動削除が必要
FULL_PATH_NAMESProjectYES ファイルリストのファイル名のフルパス出力有無
参照:STRIP_FROM_PATH
G
GENERATE_AUTOGEN_DEFAutoGenNO
GENERATE_BUGLISTBuildYES@bug【バグ (一覧)】の一覧出力有無
GENERATE_CHIHTMLNO
GENERATE_DEPRECATEDLISTBuildYES @deprecated【非推奨 (一覧)】の一覧出力有無
GENERATE_DOCBOOKDocbookNODocBook 出力有無
GENERATE_DOCSETHTMLNO
GENERATE_ECLIPSEHELPHTMLNO
GENERATE_HTML
(Wizard-Output-"HTML")
HTML
Wizard
YESHTML 出力有無
GENERATE_HTMLHELP
(Wizard-Output-"HTML-prepare for compressed HTML (.chm)")
HTML
Wizard
NOHTML Help 出力有無
GENERATE_LATEX
(Wizard-Output-"LaTeX")
LaTeX
Wizard
YESLaTeX 出力有無
GENERATE_LEGENDDotYES凡例ページへのリンク生成 (dotツール未使用のクラス図)
GENERATE_MAN
(Wizard-Output-"Man pages")
Man
Wizard
NOman page 出力有無
GENERATE_PERLMODPerlModNO
GENERATE_QHPHTMLNO
GENERATE_RTF
(Wizard-Output-"Rich Text Format (RTF)")
RTF
Wizard
NORich Text Format (RTF) 出力有無
GENERATE_TAGFILEExternal
GENERATE_TESTLISTBuildYES@test【テストケース (一覧)】の一覧出力有無
GENERATE_TODOLISTBuildYES@todo【TODO (一覧)】の一覧出力有無
GENERATE_TREEVIEW
(Wizard-Output-"HTML-with navigation panel")
HTML
Wizard
NO 左側ナビの作成有無 【HTML出力】
(YESの場合にDISABLE_INDEX【上部インデックスの無効化】が設定可能)
GENERATE_XML
(Wizard-Output-"XML")
XML
Wizard
NOXML 出力有無
GRAPHICAL_HIERARCHY
(Wizard-Diagrams-"Overall Class hierrchy")
Dot
Wizard
YES グラフィカルなクラス階層構造有無
GROUP_GRAPHSDotYESグループの依存関係の表示有無
GROUP_NESTED_COMPOUNDSProjectNO入れ子のクラス・構造体の同一グループ追加有無
H
HAVE_DOT
(Wizard-Diagrams-"Use dot tool from th GraphViz package")
Dot
Wizard
NOdotツール(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_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_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_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_OUTPUTHTMLhtml出力ディレクトリ 【HTML出力】
HTML_STYLESHEET HTMLユーザー定義のCSS 【HTML出力】 非推奨/廃止予定 HTML_EXTRA_STYLESHEET 参照
HTML_TIMESTAMPHTMLNOフッタのページ生成日時の挿入有無 【HTML出力】
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 の場合)
INCLUDE_PATHPreprocessor
INCLUDED_BY_GRAPH
(Wizard-Diagrams-"Included by dependency graphs")
Dot
Wizard
YES ファイルの被インクルード関係図
(ENABLE_PREPROCESSING および SEARCH_INCLUDES が YES の場合)
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 の実行作業)ディレクトリ検索
INPUT_ENCODINGInputUTF-8ファイルのエンコード
(ソースファイル・挿入ファイル 等の設定)
例:UTF-8・CP932・SHIFT_JIS 等 (参考:libiconv)
INPUT_FILTERInput
INTERACTIVE_SVGDotNO インタラクティブSVG画像の生成
(一定サイズ以上でズーム・パン可能)
参照:DOT_IMAGE_FORMAT【dotツール生成の画像フォーマット】
INTERNAL_DOCSBuildNO 内部文書の表示有無
参照:@internal・@endinternal【内部文書】
J・K
JAVADOC_AUTOBRIEFProjectNOJavadocスタイルのコメント (/** ~ */)の先頭行を概要と認識
L
LATEX_BATCHMODELaTeXNO【LaTeX出力】
LATEX_BIB_STYLELaTeXplain【LaTeX出力】
LATEX_CMD_NAMELaTeXlatex【LaTeX出力】
LATEX_EXTRA_FILESLaTeX【LaTeX出力】
LATEX_EXTRA_STYLESHEETLaTeX【LaTeX出力】
LATEX_HEADERLaTeX【LaTeX出力】
LATEX_HIDE_INDICESLaTeXNO【LaTeX出力】
LATEX_OUTPUTLaTeXlatex【LaTeX出力】
LATEX_SOURCE_CODELaTeXNO【LaTeX出力】
LATEX_TIMESTAMPLaTeXフッタのページ生成日時の挿入有無 【LaTeX出力】
LAYOUT_FILEBuild
LOOKUP_CACHE_SIZEProject0 シンボルルックアップキャッシュのサイズ (0~9)
実行後に使用状況のレポート出力
(キャッシュサイズ:2^(16 + LOOKUP_CACHE_SIZE))
M・N
MACRO_EXPANSIONPreprocessorNO
MAKEINDEX_CMD_NAMELaTeXmakeindex【LaTeX出力】
MAN_EXTENSIONMan3【man page出力】
MAN_OUTPUTManman【man page出力】
MAN_SUBDIRMan【man page出力】
MARKDOWN_SUPPORTProjectYESマークダウンのサポート有無
MATHJAX_CODEFILEHTML
MATHJAX_EXTENSIONSHTML
MATHJAX_FORMATHTMLHTML-CSS(NativeMML・SVG)
MATHJAX_RELPATHHTMLhttp://cdn.mathjax.org/mathjax/latest
MAX_DOT_GRAPH_DEPTHDot0 dotツールの最大深度 (0~1000)
(DOT_GRAPH_MAX_NODES でも制限)
MAX_INITIALIZER_LINESBuild30 (0~10000)
MSCFILE_DIRSDotmscファイルパス (複数指定可)
MSCGEN_PATHDotMscgen実行ファイルパス (省略:検索パス)
MULTILINE_CPP_IS_BRIEFProjectNOC++スタイルのコメント (//!・///)を概要と認識
O
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_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_DIRECTIONNone出力のテキスト方向 (None・LTR・RTL・Context)
P
PAPER_TYPELaTeXa4(a4・letter・legal・executive) 【LaTeX出力】
PERLMOD_LATEXPerlModNO
PERLMOD_MAKEVAR_PREFIXPerlMod
PERLMOD_PRETTYPerlModYES
PERL_PATHExternal/usr/bin/perl
PLANTUML_CFG_FILEDotPlantUMLのコンフィグファイルのパス
PLANTUML_INCLUDE_PATHDotPlantUMLのインクルードファイルのパス (複数指定可)
PLANTUML_JAR_PATHDotplantuml.jar ファイルのパス
PREDEFINEDPreprocessor
PROJECT_BRIEF
(Wizard-Project-"Project synopsis")
Project
Wizard
プロジェクトの概要
PROJECT_NAME
(Wizard-Project-"Project name")
Project
Wizard
My Projectプロジェクト名
PROJECT_NUMBER
(Wizard-Project-"Project version or id")
Project
Wizard
プロジェクト番号
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_AUTOBRIEFProjectNOQtスタイルのコメント (/*! ~ */)の先頭行を概要と認識
QUIETMessagesNO標準出力メッセージの出力なし
R
RECURSIVE
(Wizard-Project-Scan recursively)
Input
Wizard
NO入力ファイルのサブディレクトリ検索有無
REFERENCED_BY_RELATIONSource BrowserNO参照元関数のリストアップ有無
REFERENCES_RELATIONSource BrowserNO参照先関数のリストアップ有無
REPEAT_BRIEFProjectYESメンバ・関数詳細の前に概要の出力有無
RTF_EXTENSIONS_FILERTF【RTF出力】
RTF_OUTPUTRTFrtf【RTF出力】
RTF_SOURCE_CODERTFNO【RTF出力】
RTF_STYLESHEET_FILERTF【RTF出力】
S
SEARCHDATA_FILEHTMLsearchdata.xml
SEARCHENGINE
(Wizard-Output-"HTML-With search function")
HTML
Wizard
YES検索ボックスの作成有無 【HTML出力】
SEARCHENGINE_URLHTML(なし)
付属検索エンジン
外部検索エンジン 【HTML出力】
SEARCH_INCLUDESPreprocessorYESINCLUDE_PATH 内のインクルードファイル検索有無
SEPARATE_MEMBER_PAGESProjectNOメンバ毎のページの生成有無
SHORT_NAMESProjectNO短いファイル名のファイル生成有無
(長いファイル名の未サポート環境で有用)
SHOW_FILESBuildYESファイルページの表示有無
SHOW_GROUPED_MEMB_INCBuildNOグループ化メンバ毎のインクルードファイル表示有無
SHOW_INCLUDE_FILESBuildYESファイルページのインクルードファイル表示有無
SHOW_NAMESPACESBuildYES名前空間ページの表示有無
SHOW_USED_FILESBuildYESクラス・構造体の使用ファイルリストの表示有無
SIP_SUPPORTProjectNOSIP のサポート有無
(明示的なアクセス修飾子がないクラスをpublic 指定)
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ソースファイル内ハイパーリンクのツールチップの表示有無
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_SUBSTProject単語・キーワードのマッピング指定 (複数指定可・Tclのみ)
TEMPLATE_RELATIONSDotNO クラス図・コラボレーション図にテンプレートとインスタンスの関係を表示
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_MATHJAXHTMLNO
USE_MDFILE_AS_MAINPAGEInput
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_UNDOCUMENTEDMessagesYES ドキュメント無しメンバの警告
EXTRACT_ALL が YES の場合、自動的に NO
WARN_LOGFILEMessages警告・エラー メッセージの書き込みファイル
省略:標準エラー (stderr)
WARN_NO_PARAMDOCMessagesNOパラメータ・戻り値のドキュメントが無い場合の警告有無
X・Y・Z
XML_OUTPUTXMLxml【XML出力】
XML_PROGRAMLISTINGXMLYES【XML出力】