設定

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

簡易設定

設定オプション
(Wizard)

トピック

デフォルト値

説明

全般

Step 1:Specify the working directory from which doxygen will run

Doxygen の実行作業ディレクトリ
(各種ファイルを相対パス指定とする場合、ソースファイルのディレクトリが適当、それ以外は下記 INPUT を指定)

INPUT
(Wizard-Project-"Source code directory")

Input
Wizard

入力ソースファイル名・ディレクトリ名 (複数指定可)
省略：カレント(Doxygen の実行作業)ディレクトリ検索

DOXYFILE_ENCODING

Project

UTF-8

設定ファイルのエンコード
例：UTF-8・CP932・SHIFT_JIS 等 (参考：libiconv)

INPUT_ENCODING

Input

UTF-8

ファイルのエンコード
(ソースファイル・挿入ファイル等の設定)
例：UTF-8・CP932・SHIFT_JIS 等 (参考：libiconv)

OUTPUT_DIRECTORY
(Wizard-Project-"Destination directory")

Project
Wizard

出力ディレクトリ

OUTPUT_LANGUAGE

Project

English

出力言語
⇒ 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++/CLI	C++/CLI
Java or C#	Java・C#・Python
C or PHP	C・PHP
Fortran	Fortran
VHDL	VHDL

出力形式 (Wizard からの設定が容易)

GENERATE_～
(Wizard-Output-"Select the output format(s) to generate")

Output

・HTML (Plain HTML)
・LaTeX (hyperlinked PDF)

出力形式

指定		出力形式
HTML	plain HTML	ナビゲーションなしHTML
	with navigation panel	ナビゲーションありHTML
	prepare for compressed HTML (.chm)	HTML Help
LaTeX	hyperlinked PDF	ハイパーリンク付きPDF
	PDF	PDF
	PostScript	PostScript
Man pages		Man pages
Rich Text Format (RTF)		RTF
XML		XML

設定オプション一覧

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)

トピック

デフォルト値

説明

ABBREVIATE_BRIEF

Project

The $name class
The $name widget
The $name file
is
provides
specifies
contains
represents
a
an
the

各種リスト概要の省略文字列 (複数指定可)
(概要の先頭が指定文字列の場合、指定文字列を省略し簡略化)

ALIASES

Project

エイリアス (複数指定可)

ALLEXTERNALS

External

ALLOW_UNICODE_NAMES

Project

出力ファイル名のUnicode使用有無
(NO：ASCII文字以外はエスケープ)

ALPHABETICAL_INDEX

Index

YES

クラス・構造体・共用体・インタフェース等のアルファベット順索引の生成有無

ALWAYS_DETAILED_SEC

Project

詳細セクションの常時出力有無
(REPEAT_BRIEF も YES の場合、詳細がなくても詳細セクションを出力)

AUTOLINK_SUPPORT

Project

YES

自動リンク有無
個別で無効にする場合、前に % を記述

BINARY_TOC

HTML

BRIEF_MEMBER_DESC

Project

YES

ファイル・クラスのメンバリストの概要出力有無 (Javadocに類似)

BUILTIN_STL_SUPPORT

Project

STL クラス(std::string・std::vector 等) 使用時にSTLソースを含めない

CALL_GRAPH
(Wizard-Diagrams-"Call graphs")

Dot
Wizard

呼び出し関係図の生成有無
個別に指定する場合は、下記を指定
・@callgraph【呼び出し関係図 (生成あり)】
・@hidecallgraph【呼び出し関係図 (生成なし)】

CALLER_GRAPH
(Wizard-Diagrams-"Called by graphs")

Dot
Wizard

被呼び出し関係図の生成有無
個別に指定する場合は、下記を指定
・@callergraph【被呼び出し関係図 (生成あり)】
・@hidecallergraph【被呼び出し関係図 (生成なし)】

CASE_SENSE_NAMES

Build

ファイル名の大文字・小文字混在表示有無

CHM_FILE

HTML

HTML Help ファイルのファイル名 (HTML Help ファイル)

CHM_INDEX_ENCODING

HTML

HTML Helpインデックス（hhk）・コンテンツ（hhc）・プロジェクトファイルコンテンツのエンコード (HTML Help ファイル)
例：UTF-8・CP932・SHIFT_JIS 等 (参考：libiconv)

CITE_BIB_FILES

Build

CLANG_ASSISTED_PARSING

Source Browser

CLANG_COMPILATION_DATABASE_PATH ^1.8.14
CLANG_DATABASE_PATH ^1.8.15

Source Browser

CLANG_OPTIONS

Source 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_INDEX

Index

アルファベット順索引の列数 (1～20)
参照：ALPHABETICAL_INDEX【索引の生成有無】

COMPACT_LATEX

LaTeX

【LaTeX出力】

COMPACT_RTF

RTF

YES

【RTF出力】

CPP_CLI_SUPPORT
(Wizard-Mode-"Optimize for C++/CLI output")

Project
Wizard

C++/CLI のサポート有無

CREATE_SUBDIRS

Project

各出力形式の出力ディレクトリにサブディレクトリを作成
出力ファイルを4096のサブディレクトリに振り分け
(パフォーマンス対応)

DIAFILE_DIRS

Dot

Diaファイルパス (複数指定可)
(参照：@diafile【Dia：図表ファイル挿入】)

DIA_PATH

Dot

Dia実行ファイルパス (省略：検索パス)

DIRECTORY_GRAPH

Dot

YES

ディレクトリの依存関係のグラフィカル表示有無

DISABLE_INDEX

HTML

上部インデックス無効化のオンオフ【HTML出力】
(GENERATE_TREEVIEW【ナビの作成有無】がYESの場合に設定可能)

DISTRIBUTE_GROUP_DOC

Project

最初のグループメンバドキュメントの再利用有無

DOCBOOK_OUTPUT

Docbook

docbook

【DocBook出力】

DOCBOOK_PROGRAMLISTING

Docbook

【DocBook出力】

DOCSET_BUNDLE_ID

HTML

org.doxygen.Project

DOCSET_FEEDNAME

HTML

Doxygen generated docs

DOCSET_PUBLISHER_ID

HTML

org.doxygen.Publisher

DOCSET_PUBLISHER_NAME

HTML

Publisher

DOT_CLEANUP

Dot

YES

dotツールの中間ファイルの削除

DOT_FONTNAME

Dot

Helvetica

dotツールのフォント名

DOT_FONTPATH

Dot

dotツールのフォントパス

DOT_FONTSIZE

Dot

dotツールのフォントサイズ (4～24)

DOT_GRAPH_MAX_NODES

Dot

dotツールの最大ノード数 (0～10000)
(MAX_DOT_GRAPH_DEPTH でも制限)

DOT_IMAGE_FORMAT

Dot

png

dotツール生成の画像フォーマット

DOT_MULTI_TARGETS

Dot

dotツール(1.8.10以降)の同時ファイル出力有無

DOT_NUM_THREADS

Dot

0 (自動設定)

dotツールの並行実行数 (0～32)

DOT_PATH

Dot

dotツール(Graphvizの一部)のインストールパス

DOT_TRANSPARENT

Dot

dotツールの透明背景の画像生成有無 (Windowsは未サポート)

DOTFILE_DIRS

Dot

DOTファイルパス (複数指定可)
(参照：@dotfile【DOT：ファイル挿入】)

DOXYFILE_ENCODING

Project

UTF-8

設定ファイルのエンコード
例：UTF-8・CP932・SHIFT_JIS 等 (参考：libiconv)

ECLIPSE_DOC_ID

HTML

org.doxygen.Project

ENABLED_SECTIONS

Build

条件付きセクション
下記で判定
@cond【条件付きセクション (開始)】・@endcond【条件付きセクション (終了)】
@if【条件付きコメント (if)】・@ifnot【条件付きコメント (ifnot)】・@elseif【条件付きコメント (elseif)】

ENABLE_PREPROCESSING

Preprocessor

YES

ソース・インクルードファイルの全Cプリプロセッサディレクティブ評価の有無

ENUM_VALUES_PER_LINE

HTML

(0～20)

EXAMPLE_PATH

Input

サンプルファイルパス
インクルードされるファイル名・ファイルパス (複数指定可)、下記で使用
@example【例 (ファイル)】
@dontinclude【コードブロック (ファイル・非表示)】
@include【コードブロック (ファイル)】
@includedoc【ファイル挿入 (コマンド有効)】
@includelineno【行番号付きコードブロック (ファイル)】
@snippet【コードブロック (ファイル指定部分)】
@snippetdoc【ファイル部分挿入 (コマンド有効)】
@snippetlineno【行番号付きコードブロック (ファイル指定部分)】
@verbinclude【テキストブロック (ファイル)】
@htmlinclude【HTML：ファイル挿入】
@latexinclude【LaTeX：ファイル挿入】

EXAMPLE_PATTERNS

Input

EXAMPLE_RECURSIVE

Input

EXCLUDE

Input

INPUT【入力ソースファイル名・ディレクトリ名】から除外するファイル名・ディレクトリ名

EXCLUDE_PATTERNS

Input

INPUT【入力ソースファイル名・ディレクトリ名】のディレクトリから除外するワイルドカードパターン (test*.* 等)

EXCLUDE_SYMBOLS

Input

EXCLUDE_SYMLINKS

Input

シンボリックリンクのファイル・ディレクトリの除外有無

EXPAND_AS_DEFINED

Preprocessor

EXPAND_ONLY_PREDEF

Preprocessor

EXT_LINKS_IN_WINDOW

HTML

EXTENSION_MAPPING

Project

ファイル拡張子のマッピング
【ファイル拡張子】=【言語】
【ファイル拡張子】：拡張子なしは no_extension
参照：FILE_PATTERNS

EXTERNAL_GROUPS

External

YES

EXTERNAL_PAGES

External

YES

EXTERNAL_SEARCH

HTML

EXTERNAL_SEARCH_ID

HTML

EXTRACT_ALL
(Wizard-Mode-"All Entities")

Build
Wizard

有効コメントなし項目の詳細出力有無
WARNINGS【警告メッセージの出力有無】は無視されて出力なし
下記は有効
・EXTRACT_PRIVATE【プライベートメンバの出力有無】
・EXTRACT_STATIC【静的メンバの出力有無】

EXTRACT_ANON_NSPACES

Build

匿名名前空間メンバの出力有無

EXTRACT_LOCAL_CLASSES

Build

YES

ローカル定義のクラス・構造体の出力有無

EXTRACT_LOCAL_METHODS

Build

ローカルメソッドの出力有無【Objective-C】

EXTRACT_PACKAGE

Build

パッケージ・内部スコープの全メンバの出力有無

EXTRACT_PRIVATE

Build

クラスのプライベートメンバの出力有無

EXTRACT_PRIV_VIRTUAL ^1.8.16

Build

プライベート仮想メソッドの出力有無

EXTRACT_STATIC

Build

静的メンバの出力有無

EXTRA_PACKAGES

LaTeX

【LaTeX出力】

EXTRA_SEARCH_MAPPINGS

HTML

FILE_PATTERNS

Input

INPUT【入力ソースファイル名・ディレクトリ名】のディレクトリ内のワイルドカードパターン (*.cpp 等)

FILE_VERSION_FILTER

Build

FILTER_PATTERNS

Input

FILTER_SOURCE_FILES

Input

FILTER_SOURCE_PATTERNS

Input

FORCE_LOCAL_INCLUDES

Build

<～> ではなく "～" でインクルードファイルをリスト

FORMULA_FONTSIZE

HTML

LaTeX 数式のフォントサイズ (8～50) 【HTML出力】
form_*.png ファイルの手動削除が必要

FORMULA_MACROFILE ^1.8.17

HTML

FORMULA_TRANSPARENT

HTML

数式イメージの透過 PNG 生成有無【HTML出力】
form_*.png ファイルの手動削除が必要

FULL_PATH_NAMES

Project

YES

ファイルリストのファイル名のフルパス出力有無
参照：STRIP_FROM_PATH

GENERATE_AUTOGEN_DEF

AutoGen

GENERATE_BUGLIST

Build

YES

@bug【バグ (一覧)】の一覧出力有無

GENERATE_CHI

HTML

GENERATE_DEPRECATEDLIST

Build

YES

@deprecated【非推奨 (一覧)】の一覧出力有無

GENERATE_DOCBOOK

Docbook

DocBook 出力有無

GENERATE_DOCSET

HTML

GENERATE_ECLIPSEHELP

HTML

GENERATE_HTML
(Wizard-Output-"HTML")

HTML
Wizard

YES

HTML 出力有無

GENERATE_HTMLHELP
(Wizard-Output-"HTML-prepare for compressed HTML (.chm)")

HTML
Wizard

HTML Help 出力有無

GENERATE_LATEX
(Wizard-Output-"LaTeX")

LaTeX
Wizard

YES

LaTeX 出力有無

GENERATE_LEGEND

Dot

YES

凡例ページへのリンク生成 (dotツール未使用のクラス図)

GENERATE_MAN
(Wizard-Output-"Man pages")

Man
Wizard

man page 出力有無

GENERATE_PERLMOD

PerlMod

GENERATE_QHP

HTML

GENERATE_RTF
(Wizard-Output-"Rich Text Format (RTF)")

RTF
Wizard

Rich Text Format (RTF) 出力有無

GENERATE_TAGFILE

External

GENERATE_TESTLIST

Build

YES

@test【テストケース (一覧)】の一覧出力有無

GENERATE_TODOLIST

Build

YES

@todo【TODO (一覧)】の一覧出力有無

GENERATE_TREEVIEW
(Wizard-Output-"HTML-with navigation panel")

HTML
Wizard

左側ナビの作成有無【HTML出力】
(YESの場合にDISABLE_INDEX【上部インデックスの無効化】が設定可能)

GENERATE_XML
(Wizard-Output-"XML")

XML
Wizard

XML 出力有無

GRAPHICAL_HIERARCHY
(Wizard-Diagrams-"Overall Class hierrchy")

Dot
Wizard

YES

グラフィカルなクラス階層構造有無

GROUP_GRAPHS

Dot

YES

グループの依存関係の表示有無

GROUP_NESTED_COMPOUNDS

Project

入れ子のクラス・構造体の同一グループ追加有無

HAVE_DOT
(Wizard-Diagrams-"Use dot tool from th GraphViz package")

Dot
Wizard

dotツール(Graphvizの一部)の使用有無

HHC_LOCATION

HTML

HIDE_COMPOUND_REFERENCE

Build

ページタイトル部分の追加文言の非表示 (例：クラスページの"クラス")

HIDE_FRIEND_COMPOUNDS

Build

friend（class | struct | union）宣言を非表示

HIDE_IN_BODY_DOCS

Build

関数内ドキュメントの非表示

HIDE_SCOPE_NAMES

Build

フルクラスと名前空間のスコープを持つメンバを非表示

HIDE_UNDOC_CLASSES

Build

有効コメントなしクラスをクラス階層で非表示

HIDE_UNDOC_MEMBERS

Build

クラス・ファイルの有効コメントなしメンバを非表示

HIDE_UNDOC_RELATIONS

Dot

YES

クラス図・コラボレーション図で未記述のクラス等を非表示

HTML_COLORSTYLE_GAMMA
(Wizard-Output-"HTML [Change color...]")

HTML
Wizard

ガンマ補正 [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_MENUS

HTML

YES

上部インデックスの動的メニュー【HTML出力】

HTML_DYNAMIC_SECTIONS

HTML

開閉可能セクションの有効化 (クラス図等) 【HTML出力】

HTML_EXTRA_FILES

HTML

【HTML出力】

HTML_EXTRA_STYLESHEET

HTML

ユーザー定義の追加CSS 【HTML出力】
(出力ディレクトリにコピー)

HTML_FILE_EXTENSION

HTML

.html

出力ページのファイル拡張子 (例：.htm・.php・.asp) 【HTML出力】

HTML_FOOTER

HTML

ユーザー定義のフッタ部HTMLファイル【HTML出力】
(doxygen -w html でテンプレートファイル作成可 Fine-tuning the output )
使用可能なマーカーは、HTML_HEADER 参照

HTML_HEADER

HTML

ユーザー定義のヘッダ部HTMLファイル【HTML出力】
(doxygen -w html でテンプレートファイル作成可 Fine-tuning the output )
下記マーカーが使用可

マーカー	備考
$title	ページタイトル
$datetime	現在日時
$date	現在日付
$year	現在年
$doxygenversion	Doxygenのバージョン
$projectname	プロジェクト名 (参照：PROJECT_NAME)
$projectnumber	プロジェクト番号 (参照：PROJECT_NUMBER)
$projectbrief	プロジェクトの概要 (参照：PROJECT_BRIEF)
$projectlogo	プロジェクトロゴ (参照：PROJECT_LOGO)
$treeview	ナビゲーションツリー
$search	検索ボックス
$mathjax	MathJax用JavaScript・スタイルシート
$relpath^	HTML出力ディレクトリへの相対パス

HTML_INDEX_NUM_ENTRIES

HTML

100

[0～9999] 【HTML出力】

HTML_OUTPUT

HTML

html

出力ディレクトリ【HTML出力】

HTML_STYLESHEET

HTML

ユーザー定義のCSS 【HTML出力】非推奨/廃止予定 HTML_EXTRA_STYLESHEET 参照

HTML_TIMESTAMP

HTML

フッタのページ生成日時の挿入有無【HTML出力】

IDL_PROPERTY_SUPPORT

Project

YES

IDL プロパティのサポート有無
(propget・propput 属性を get・set メソッドに置き換え)

IGNORE_PREFIX

Index

索引で無視するプリフィックス (複数指定可)
(同一プリフィックスが偏る場合に指定)
参照：ALPHABETICAL_INDEX【索引の生成有無】

IMAGE_PATH

Input

画像ファイルパス
@image【画像】

INCLUDE_FILE_PATTERNS

Preprocessor

INCLUDE_GRAPH
(Wizard-Diagrams-"Include dependency graphs")

Dot
Wizard

YES

ファイルのインクルード関係図
(ENABLE_PREPROCESSING および SEARCH_INCLUDES が YES の場合)

INCLUDE_PATH

Preprocessor

INCLUDED_BY_GRAPH
(Wizard-Diagrams-"Included by dependency graphs")

Dot
Wizard

YES

ファイルの被インクルード関係図
(ENABLE_PREPROCESSING および SEARCH_INCLUDES が YES の場合)

INHERIT_DOCS

Project

YES

コメントがないメンバは継承元からドキュメントを継承

INLINE_GROUPED_CLASSES

Project

クラス・構造体・共用体をグループにまとめて出力

INLINE_INFO

Build

YES

インラインメンバに[inline]タグの挿入有無

INLINE_INHERITED_MEMB

Project

継承メンバの出力有無
(基本クラスのコンストラクタ・デストラクタ・代入演算子は対象外)

INLINE_SIMPLE_STRUCTS

Project

パブリックデータフィールド・単純typedefフィールドのみの構造体・クラス・共用体のインライン出力有無

INLINE_SOURCES

Source Browser

関数・クラス・列挙体の本体をインラインで挿入 (不備あり)

INPUT
(Wizard-Project-"Source code directory")

Input
Wizard

入力ソースファイル名・ディレクトリ名 (複数指定可)
省略：カレント(Doxygen の実行作業)ディレクトリ検索

INPUT_ENCODING

Input

UTF-8

ファイルのエンコード
(ソースファイル・挿入ファイル等の設定)
例：UTF-8・CP932・SHIFT_JIS 等 (参考：libiconv)

INPUT_FILTER

Input

INTERACTIVE_SVG

Dot

インタラクティブSVG画像の生成
(一定サイズ以上でズーム・パン可能)
参照：DOT_IMAGE_FORMAT【dotツール生成の画像フォーマット】

INTERNAL_DOCS

Build

内部文書の表示有無
参照：@internal・@endinternal【内部文書】

J・K

JAVADOC_AUTOBRIEF

Project

Javadocスタイルのコメント (/** ～ */)の先頭行を概要と認識

JAVADOC_BANNER ^1.8.16

Project

LATEX_BATCHMODE

LaTeX

【LaTeX出力】

LATEX_BIB_STYLE

LaTeX

plain

【LaTeX出力】

LATEX_CMD_NAME

LaTeX

latex

【LaTeX出力】

LATEX_EMOJI_DIRECTORY ^1.8.15

LaTeX

【LaTeX出力】

LATEX_EXTRA_FILES

LaTeX

【LaTeX出力】

LATEX_EXTRA_STYLESHEET

LaTeX

【LaTeX出力】

LATEX_FOOTER

LaTeX

【LaTeX出力】

LATEX_HEADER

LaTeX

【LaTeX出力】

LATEX_HIDE_INDICES

LaTeX

【LaTeX出力】

LATEX_MAKEINDEX_CMD ^1.8.15

LaTeX

\makeindex

【LaTeX出力】

LATEX_OUTPUT

LaTeX

latex

【LaTeX出力】

LATEX_SOURCE_CODE

LaTeX

【LaTeX出力】

LATEX_TIMESTAMP

LaTeX

フッタのページ生成日時の挿入有無【LaTeX出力】

LAYOUT_FILE

Build

LOOKUP_CACHE_SIZE

Project

シンボルルックアップキャッシュのサイズ (0～9)
実行後に使用状況のレポート出力
(キャッシュサイズ：2^(16 + LOOKUP_CACHE_SIZE))

M・N

MACRO_EXPANSION

Preprocessor

MAKEINDEX_CMD_NAME

LaTeX

makeindex

【LaTeX出力】

MAN_EXTENSION

Man

【man page出力】

MAN_LINKS

Man

【man page出力】

MAN_OUTPUT

Man

man

【man page出力】

MAN_SUBDIR

Man

【man page出力】

MARKDOWN_SUPPORT

Project

YES

マークダウンのサポート有無

MATHJAX_CODEFILE

HTML

MATHJAX_EXTENSIONS

HTML

MATHJAX_FORMAT

HTML

HTML-CSS

(NativeMML・SVG)

MATHJAX_RELPATH

HTML

http://cdn.mathjax.org/mathjax/latest

MAX_DOT_GRAPH_DEPTH

Dot

dotツールの最大深度 (0～1000)
(DOT_GRAPH_MAX_NODES でも制限)

MAX_INITIALIZER_LINES

Build

30 (0～10000)

MSCFILE_DIRS

Dot

mscファイルパス (複数指定可)

MSCGEN_PATH ^1.8.16

Dot

Mscgen実行ファイルパス (省略：検索パス)

MULTILINE_CPP_IS_BRIEF

Project

C++スタイルのコメント (//!・///)を概要と認識

OPTIMIZE_FOR_FORTRAN
(Wizard-Mode-"Optimize for Fortran output")

Project
Wizard

Fortran のソースでのみ構成されている場合の出力最適化の有無

OPTIMIZE_OUTPUT_FOR_C
(Wizard-Mode-"Optimize for C or PHP output")

Project
Wizard

C のソースでのみ構成されている場合の出力最適化の有無

OPTIMIZE_OUTPUT_JAVA
(Wizard-Mode-"Optimize for Java or C# output")

Project
Wizard

Java または C# またはPython のソースでのみ構成されている場合の出力最適化の有無

OPTIMIZE_OUTPUT_SLICE ^1.8.15

Project

OPTIMIZE_OUTPUT_VHDL
(Wizard-Mode-"Optimize for VHDL output")

Project
Wizard

VHDL のソースでのみ構成されている場合の出力最適化の有無

OUTPUT_DIRECTORY
(Wizard-Project-"Destination directory")

Project
Wizard

出力ディレクトリ

OUTPUT_LANGUAGE

Project

English

出力言語
⇒ Japanese・Japanese-en

OUTPUT_TEXT_DIRECTION ^1.8.15

Project

None

出力のテキスト方向 (None・LTR・RTL・Context)

PAPER_TYPE

LaTeX

(a4・letter・legal・executive) 【LaTeX出力】

PDF_HYPERLINKS
(Wizard-LaTeX-"as intermediate format for hyperlinked PDF")

LaTeX
Wizard

YES

【LaTeX出力】

PERLMOD_LATEX

PerlMod

PERLMOD_MAKEVAR_PREFIX

PerlMod

PERLMOD_PRETTY

PerlMod

YES

PERL_PATH ^1.8.16

External

/usr/bin/perl516

PLANTUML_CFG_FILE

Dot

PlantUMLのコンフィグファイルのパス

PLANTUML_INCLUDE_PATH

Dot

PlantUMLのインクルードファイルのパス (複数指定可)

PLANTUML_JAR_PATH

Dot

plantuml.jar ファイルのパス

PREDEFINED

Preprocessor

PROJECT_BRIEF
(Wizard-Project-"Project synopsis")

Project
Wizard

プロジェクトの概要

PROJECT_LOGO
(Wizard-Project-"Project logo")

Project
Wizard

プロジェクトロゴ

PROJECT_NAME
(Wizard-Project-"Project name")

Project
Wizard

My Project

プロジェクト名

PROJECT_NUMBER
(Wizard-Project-"Project version or id")

Project
Wizard

プロジェクト番号

QCH_FILE

HTML

QHG_LOCATION

HTML

QHP_CUST_FILTER_ATTRS

HTML

QHP_CUST_FILTER_NAME

HTML

QHP_NAMESPACE

HTML

org.doxygen.Project

QHP_SECT_FILTER_ATTRS

HTML

QHP_VIRTUAL_FOLDER

HTML

doc

QT_AUTOBRIEF

Project

Qtスタイルのコメント (/*! ～ */)の先頭行を概要と認識

QUIET

Messages

標準出力メッセージの出力なし

RECURSIVE
(Wizard-Project-Scan recursively)

Input
Wizard

入力ファイルのサブディレクトリ検索有無

REFERENCED_BY_RELATION

Source Browser

参照元の表示有無

REFERENCES_LINK_SOURCE

Source Browser

YES

参照元関数・参照先関数をソースコードにリンク
NO：ドキュメントにリンク

REFERENCES_RELATION

Source Browser

参照先の表示有無

REPEAT_BRIEF

Project

YES

メンバ・関数詳細の前に概要の出力有無

RTF_EXTENSIONS_FILE

RTF

【RTF出力】

RTF_HYPERLINKS

RTF

【RTF出力】

RTF_OUTPUT

RTF

rtf

【RTF出力】

RTF_SOURCE_CODE

RTF

【RTF出力】

RTF_STYLESHEET_FILE

RTF

【RTF出力】

SEARCHDATA_FILE

HTML

searchdata.xml

SEARCHENGINE
(Wizard-Output-"HTML-With search function")

HTML
Wizard

YES

検索ボックスの作成有無【HTML出力】

SEARCHENGINE_URL

HTML

(なし)
付属検索エンジン

外部検索エンジン【HTML出力】

SEARCH_INCLUDES

Preprocessor

YES

INCLUDE_PATH 内のインクルードファイル検索有無

SEPARATE_MEMBER_PAGES

Project

メンバ毎のページの生成有無

SERVER_BASED_SEARCH

HTML

SHORT_NAMES

Project

短いファイル名のファイル生成有無
(長いファイル名の未サポート環境で有用)

SHOW_FILES

Build

YES

ファイルページの表示有無

SHOW_GROUPED_MEMB_INC

Build

グループ化メンバ毎のインクルードファイル表示有無

SHOW_INCLUDE_FILES

Build

YES

ファイルページのインクルードファイル表示有無

SHOW_NAMESPACES

Build

YES

名前空間ページの表示有無

SHOW_USED_FILES

Build

YES

クラス・構造体の使用ファイルリストの表示有無

SIP_SUPPORT

Project

SIP のサポート有無
(明示的なアクセス修飾子がないクラスをpublic 指定)

SKIP_FUNCTION_MACROS

Preprocessor

YES

SORT_BRIEF_DOCS

Build

SORT_BY_SCOPE_NAME

Build

SORT_GROUP_NAMES

Build

SORT_MEMBERS_CTORS_1ST

Build

SORT_MEMBER_DOCS

Build

YES

SOURCE_BROWSER
(Wizard-Mode-"Include cross-referenced source code in the output")

Source Browser
Wizard

ソースファイルのリスト生成有無
(ソースファイルは相互参照)
参照：VERBATIM_HEADERS

SOURCE_TOOLTIPS

Source Browser

ソースファイル内ハイパーリンクのツールチップの表示有無

STRICT_PROTO_MATCHING

Build

STRIP_CODE_COMMENTS

Source Browser

YES

ソースコードからDoxygenコマンドのコメントを非表示

STRIP_FROM_INC_PATH

Project

クラス使用のヘッダファイルの除去パス (複数指定可)

STRIP_FROM_PATH

Project

ファイルリストの除去パス (複数指定可・相対パス指定可)
省略：Doxygen実行ディレクトリ
参照：FULL_PATH_NAMES

SUBGROUPING

Project

YES

同タイプのクラスメンバーグループをサブグループ化の有無

TAB_SIZE

Project

タブサイズ (1～16)

TAGFILES

External

TCL_SUBST

Project

単語・キーワードのマッピング指定 (複数指定可・Tclのみ)

TEMPLATE_RELATIONS

Dot

クラス図・コラボレーション図にテンプレートとインスタンスの関係を表示

TOC_EXPAND

HTML

TOC_INCLUDE_HEADINGS

Project

マークダウンの見出しをidなしでも目次出力するレベル (0～99)

TREEVIEW_WIDTH

HTML

250

左側ナビの初期幅 (0～1500 ピクセル)【HTML出力】

TYPEDEF_HIDES_STRUCT

Project

構造体・共用体・列挙型のtypedefを構造体等として出力
(NO：名前空間・クラスのメンバとして出力)

UML_LIMIT_NUM_FIELDS

Dot

UMLスタイルのフィールド数のしきい値 (0～100)
しきい値の150%までは全て表示、超えるとしきい値まで表示
参照：UML_LOOK

UML_LOOK

Dot

クラス図・コラボレーション図のUMLスタイル化

USE_HTAGS

Source Browser

USE_MATHJAX

HTML

MathJaxの使用有無 (LaTeXのHTML出力)

USE_MDFILE_AS_MAINPAGE

Input

USE_PDFLATEX
(Wizard-LaTeX-"as intermediate format for PDF")

LaTeX
Wizard

YES

【LaTeX出力】

VERBATIM_HEADERS

Source Browser

YES

クラス用インクルードファイルのコピー生成の有無
参照：SOURCE_BROWSER

WARNINGS

Messages

YES

標準エラー（stderr）の警告メッセージの出力有無

WARN_AS_ERROR

Messages

警告時の停止有無

WARN_FORMAT

Messages

$file:$line: $text

警告メッセージの形式

WARN_IF_DOC_ERROR

Messages

YES

潜在的エラーの警告有無

WARN_IF_UNDOCUMENTED

Messages

YES

ドキュメント無しメンバの警告
EXTRACT_ALL が YES の場合、自動的に NO

WARN_LOGFILE

Messages

警告・エラーメッセージの書き込みファイル
省略：標準エラー (stderr)

WARN_NO_PARAMDOC

Messages

パラメータ・戻り値のドキュメントが無い場合の警告有無

X・Y・Z

XML_NS_MEMB_FILE_SCOPE ^1.8.15

XML

【XML出力】

XML_OUTPUT

XML

xml

【XML出力】

XML_PROGRAMLISTING

XML

YES

【XML出力】

省略・^1.8.14	Ver. 1.8.14 対応
^x.y.z	Ver. x.y.z 対応
^x.y.z	Ver. x.y.z で廃止
	単一の単語
	行末までが対象
	次の段落までが対象
構文：[～]	～は省略可能
構文：[～]	[と] はそのまま記述
構文：x\|y	x または y
構文： \|	\| はそのまま記述
	半角スペース
	Graphviz を使用
	Mscgen を使用
	PlantUML を使用
	Dia を使用
Link	別リファレンスリンク
Link	外部リンク