Doxygen の設定ファイル (Doxyfile) でよく使用する設定のまとめです。
基本的な設定
PROJECT_NAME = MyProjectGENERATE_HTML = YES
GENERATE_CHI = NO
GENERATE_LATEX = NO ※これがデフォルトで YES になってる
GENERATE_RTF = NO
GENERATE_MAN = NOSOURCE_BROWSER = YES # Files tab includes *.cpp files.
GENERATE_TREEVIEW = YES # A side panel will be generated.QUIET = NO
WARNINGS = YES指定したディレクトリ内のファイルを対象にする
INPUT =
RECURSIVE = YESINPUT = /home/john/src
RECURSIVE = YES特定のディレクトリを対象外にする
パターンに一致する名前のディレクトリをドキュメント化の対象から外すことができます。
EXCLUDE_PATTERNS = */test/*パターンではなく、ディレクトリパスを明示する場合は、EXCLUDE タグを使用できます。
指定した拡張子のファイルを対象にする
FILE_PATTERNS = *.cpp *.hドキュメントの出力先ディレクトリの設定
ドキュメントの出力先ディレクトリは、ドキュメントのファイル形式ごとに設定できます。
さらに OUTPUT_DIRECTORY を設定しておくと、ディレクトリのプレフィックスとして使用されます。
例えば、以下のようにすると、HTML ドキュメントは doc/html 以下に生成されるようになります。
HTML_OUTPUT = html
RTF_OUTPUT = rtf
LATEX_OUTPUT = latex
XML_OUTPUT = xml
MAN_OUTPUT = man
OUTPUT_DIRECTORY = doc
HTML_OUTPUT = htmlDoxygen コメントの付いていないメンバメソッドなども対象にする
EXTRACT_ALL = YES # default:NO
ドキュメントにソースコードを含める
INLINE_SOURCES = YES