Doxyfile(その他)

概要:Doxyfile(基本的な設定)Doxyfile(拡張ツールの設定) 以外

Doxygen実行時パフォーマンス

概要:通常設定するのは DOT_MULTI_TARGETS ぐらい?
Doxyfile(Doxygen実行時の設定項目)
タグ 初期値 設定値 補足
LOOKUP_CACHE_SIZE 0   doxygen実行時のキャッシュサイズ(有効範囲は、0..9)
DOT_NUM_THREADS 0   (Graphvizを使う場合のみ設定)Doxygenが平行実行できるdot呼び出しの数
DOT_MULTI_TARGETS NO YES (Graphvizを使う場合のみ設定)実行速度がたぶん速くなる(Graphvizのバージョンが1.8.10以上の場合のみ有効)

Warnings(Doxygenコメントチェック)

概要:ソースコードにDoxygenのコメントが付いているかチェックする場合、警告で確認出来る
Doxyfile(Doxygenコメントチェックをする場合の確認項目)
タグ 初期値 設定値 特性 補足
WARNINGS YES YES required  
WARN_IF_UNDOCUMENTED YES YES   ドキュメント付けされていないメンバーに対して警告を生成。但し、EXTRACT_ALLがYESの場合は無効
WARN_IF_DOC_ERROR YES YES required
ドキュメント内での致命的なエラーについての警告。以下に例を示す。
  • ドキュメント付けされた関数のパラメータにドキュメントがない
  • 存在しないパラメータのドキュメントがある
  • あるいはマークアップコマンドを間違って使用されている
WARN_NO_PARAMDOC NO YES   関数はドキュメント付けされているが、引数や戻り値のドキュメントがない関数についての警告
WARN_FORMAT “$file:$line: $text”   implied 警告メッセージのフォーマット
WARN_LOGFILE     implied 警告やエラーメッセージを書き込むファイル名。 ブランクだとstderrに出力

External(分割ドキュメント)

概要:大規模なプロジェクトなどで、ドキュメントを分割する場合
Doxyfile(Doxygenドキュメントを分割生成する場合の設定項目)
タグ 初期値 補足
TAGFILES   タグファイル名
GENERATE_TAGFILE   タグファイルを生成
ALLEXTERNALS NO 外部クラスをすべてクラスインデックスにリストする
EXTERNAL_GROUPS YES 外部のグループをすべてモジュールインデックスにリストする
EXTERNAL_PAGES YES 外部のウェブページをすべて関連するページのインデックスにリストする
PERL_PATH /usr/bin/perl Perl パス

Compatible(下位互換性)

概要:古いDoxygenのコメントがある場合などの微調整
Doxyfile(下位互換性)
タグ 初期値 補足
ALLOW_UNICODE_NAMES NO
(導入バージョン 1.8.7)
YESの場合、生成するファイルの名前に非ASCII文字を使う。
NOの場合、非ASCII文字をエスケープ(たとえば Unicode U+3044 は、 _xE3_x81_x84)。
SHORT_NAMES NO 短い名前
JAVADOC_AUTOBRIEF NO JavaDoc スタイルのコメントの先頭行 (最初の . まで) を要約説明と解釈
QT_AUTOBRIEF NO Qt スタイルコメントの先頭行 (最初の . まで) を要約説明と解釈
MULTILINE_CPP_IS_BRIEF NO 複数行 C++ 特別コメント (//! や /// コメントのブロック) を要約説明とする
MARKDOWN_SUPPORT YES コメントをMarkdownフォーマットに従って前処理するか
DISTRIBUTE_GROUP_DOC NO グループ内の最初のメンバーのドキュメントを、そのグループの他のメンバーに対して再利用する
EXTRACT_LOCAL_CLASSES YES ソースファイルの中でローカルに定義されたクラスを出力(javaでは無効)
CASE_SENSE_NAMES NO NO であれば、ファイル名を小文字だけで生成

Customize(カスタマイズ)

概要:カスタマイズ
Doxyfile(カスタマイズ)
タグ 初期値 補足
ABBREVIATE_BRIEF    
ALIASES   エイリアス
INTERNAL_DOCS NO @internal コマンドに続くドキュメントをインクルードするか否か
GENERATE_TODOLIST YES TODOリスト
GENERATE_TESTLIST YES テストリスト
GENERATE_BUGLIST YES バグリスト
GENERATE_DEPRECATEDLIST YES 非推奨リスト
ENABLED_SECTIONS   条件付ドキュメントセクションを出力(@if ... @endif 、 @cond ... @endcond)
MAX_INITIALIZER_LINES 30 初期化リストの最大数
FILE_VERSION_FILTER   各ファイルの現バージョンを取得しようとするプログラムやスクリプトを指定
FILE_PATTERNS   (*.cpp *.h のような) 複数のワイルドカードパターンを指定
EXCLUDE   INPUT ソースファイルから除外したいファイルやディレクトリを指定
EXCLUDE_SYMLINKS NO シンボリックリンク(unix)を、入力から除外するか
EXCLUDE_PATTERNS   すべてのtestディレクトリを除外するには */test/*
EXCLUDE_SYMBOLS   除外するシンボル
EXAMPLE_PATH   サンプルコード片を含むファイルやディレクトリを指定
EXAMPLE_PATTERNS   EXAMPLE_PATHのワイルドカードパターン(*.h, *.hppなど)
EXAMPLE_RECURSIVE NO EXAMPLE_PATHのサブディレクトリを再帰的に検索するか
IMAGE_PATH   ドキュメントにインクルードする画像の格納先
INPUT_FILTER   入力ファイルフィルター
FILTER_PATTERNS   pattern=filter のリスト
FILTER_SOURCE_FILES NO INPUT_FILTERをSOURCE_BROWSERのソースファイル作成時に適用するか
FILTER_SOURCE_PATTERNS   ファイルパターンごとにソースフィルタを指定(FILTER_SOURCE_FILESが有効の場合のみ)
USE_MDFILE_AS_MAINPAGE   メインページ(index.html)に配置するmarkdown ファイル
COLS_IN_ALPHA_INDEX 5 アルファベット順インデックスの分割するカラム数 (範囲は、[1..20])
IGNORE_PREFIX   無視すべき接頭辞
ENUM_VALUES_PER_LINE 4 一行にまとめられる enum の値の数 (範囲は [1..20])
MACRO_EXPANSION NO 条件コンパイルだけでなく、ソースコード内のすべてのマクロ名を展開するか
EXPAND_ONLY_PREDEF NO マクロ展開は、PREDEFINED タグと EXPAND_AS_DEFINED タグで指定したものだけにするか
SEARCH_INCLUDES YES #include が見つかった場合、INCLUDE_PATH 内のインクルードファイルを検索するか
INCLUDE_PATH   プリプロセッサによって処理すべきインクルードファイルのディレクトリを指定
INCLUDE_FILE_PATTERNS   INCLUDE_PATHのワイルドカードパターン(*.h, *.hppなど)
PREDEFINED   gcc の -D オプション的な
EXPAND_AS_DEFINED   展開されるべきマクロ名のリストを指定
HIDE_UNDOC_RELATIONS YES 継承・コラボレーション図は、ドキュメント付けされていないかクラスでなければ、継承と使用の関係を隠す