Doxyfile(基本的な設定)

概要:

Doxygen の設定ファイル Doxyfile の設定頻度が高いと思われる項目

初めに確認する項目:

毎回確認する項目

プロジェクトごとに確認する項目
Doxyfile(初めに確認する設定項目)
タグ 初期値 basic 補足
DOXYFILE_ENCODING UTF-8   出力エンコーディング(libiconv)
PROJECT_NAME “My Project”   プロジェクト名
PROJECT_NUMBER     プロジェクト番号
PROJECT_BRIEF     プロジェクトの概要
PROJECT_LOGO     プロジェクトのロゴ
OUTPUT_DIRECTORY     出力先
FULL_PATH_NAMES YES   フルパス
STRIP_FROM_PATH   $(INPUT) フルパスの一部を除去
STRIP_FROM_INC_PATH   $(INPUT) インクルードするヘッダファイルのパスから、一部を除去
INPUT     入力ディレクトリー
INPUT_ENCODING UTF-8 cp932 入力エンコーディング(Windowsの場合cp932かも)

入力言語

INPUTとするプログラム言語
Doxyfile(INPUTとする言語)
タグ 初期値 言語 補足
TCL_SUBST   TCL  
OPTIMIZE_OUTPUT_FOR_C NO C C のソースのみのプロジェクトの場合指定
OPTIMIZE_OUTPUT_JAVA NO Java/Python JavaPython のソースだけでプロジェクトを構成している場合
OPTIMIZE_FOR_FORTRAN NO Fortran Fortran ソースで構成されるプロジェクトの場合
OPTIMIZE_OUTPUT_VHDL NO VHDL VHDL ソースで構成されるプロジェクトの場合
EXTENSION_MAPPING     特定の拡張子についてどのパーサを使うかを指定
BUILTIN_STL_SUPPORT NO C++/STL C++STL を使用するプロジェクトの場合
CPP_CLI_SUPPORT NO C++/CLI Microsoftの C++/CLI 言語を使う場合
SIP_SUPPORT NO sip sip ソースのみでプロジェクトを構成している場合
IDL_PROPERTY_SUPPORT YES IDL Microsoftの IDL
EXTRACT_LOCAL_METHODS NO Objective-C  

設定頻度高

設定頻度が高いと思われる設定項目
Doxyfile(設定頻度が高いと思われる設定項目)
タグ 初期値 basic 詳細 大規模 interface 1ファイル 補足
CREATE_SUBDIRS NO     YES   NO 出力にサブディレクトリを使用する(大量のファイルが対象の場合は指定)
OUTPUT_LANGUAGE English Japanese         出力言語(メッセージ英語の場合 Japanese-en (Japanese with English messages))
EXTRACT_ALL NO   YES   NO   doxygenコメントがなくても、ドキュメント内の要素はすべてドキュメントに出力
EXTRACT_PRIVATE NO   YES   NO   クラスの private メンバーをすべてドキュメントに出力
EXTRACT_PACKAGE NO   YES       パッケージや内部スコープを持つメンバーをすべてドキュメントに出力
EXTRACT_STATIC NO   YES       ファイルの static メンバーをすべてドキュメントに出力
RECURSIVE NO YES YES YES YES NO 入力ディレクトリーのサブディレクトリーも再帰的に解析
SOURCE_BROWSER NO   YES NO NO   ソースをドキュメントに含めるか(VERBATIM_HEADERS も参照)
INLINE_SOURCES NO   YES NO NO   関数、クラス、列挙型 の本体を含めるか
STRIP_CODE_COMMENTS YES YES NO YES YES   ドキュメント内のソースからdoxygenコメントを除去するか
REFERENCED_BY_RELATION NO   YES       その関数を参照する関数をリストする
REFERENCES_RELATION NO   YES       その関数が呼び出したり使っている、要素をリストする
VERBATIM_HEADERS YES   YES NO     ヘッダーソースをドキュメントに含めるか(SOURCE_BROWSER も参照)
ALPHABETICAL_INDEX YES         NO アルファベット順インデックス
SEARCHENGINE YES         NO サーチエンジン
GENERATE_LATEX YES NO         LATEXの生成

HTMLのカスタマイズ

HTMLをカスタマイズする場合の設定項目
Doxyfile(HTMLをカスタマイズする場合の設定項目)
タグ 初期値 basic 特性 補足
LAYOUT_FILE     implied レイアウト(doxygen -l でDoxygenLayout.xmlファイルを生成し、編集する)
GENERATE_HTML YES   required HTMLを生成するか
HTML_OUTPUT html   implied HTMLの出力先
HTML_FILE_EXTENSION .html .xhtml implied HTMLの拡張子(DOT_IMAGE_FORMAT=svg INTERACTIVE_SVG=YESの場合 .xhtmlへ(IE9対策))
HTML_HEADER     implied ヘッダー(デフォルトのヘッダ、フッタ、CSSの生成は、doxygen -w html header.html footer.html stylesheet.css)
HTML_FOOTER     implied フッダー(デフォルトのヘッダ、フッタ、CSSの生成は、doxygen -w html header.html footer.html stylesheet.css)
HTML_STYLESHEET     implied スタイルシート(デフォルトのヘッダ、フッタ、CSSの生成は、doxygen -w html header.html footer.html stylesheet.css)
HTML_EXTRA_STYLESHEET     implied 追加のユーザー定義のカスケーディングスタイルシートの指定
HTML_EXTRA_FILES     implied HTML 出力ディレクトリにコピーしたいイメージファイルやソースファイルを指定
HTML_COLORSTYLE_HUE 220   implied  
HTML_COLORSTYLE_SAT 100   implied HTML出力での色の純度(彩度)を指定します。0は、グレースケールを、255は、最も鮮明な色
HTML_COLORSTYLE_GAMMA 80   implied ガンマ補正
HTML_TIMESTAMP YES NO implied 各HTMLページが生成される際に、フッターに生成日時が出力
HTML_DYNAMIC_SECTIONS NO   implied 表示非表示を制御できるセクションを生成
HTML_INDEX_NUM_ENTRIES 100   implied 木構造のインデックスに最初に表示するエントリーの数
DISABLE_INDEX NO   implied 各ページのトップのメニューを非表示
GENERATE_TREEVIEW NO YES implied フレームでツリー形式のメニューを生成する
TREEVIEW_WIDTH 250   implied ツリービューの幅