読者です 読者をやめる 読者になる 読者になる

by shigemk2

当面は技術的なことしか書かない

Doxyfileの書き方と読み方一覧

Doxygen

Let’s use doxygen!

PROJECT_NAME プロジェクトの名前を設定する。サンプルでは、 File   IO   Wrapper にした。
PROJECT_NUMBER リビジョン番号などを設定する。サンプルでは、1.0 になっている。
OUTPUT_LANGUAGE 生成するドキュメントの記述言語を設定する。言語といってもプログラム言語のことではなく、 英語や日本語など、どの自然言語を使うか、という設定である。サンプルでは、 Japanese になっている。
EXTRACT_ALL コメントの付いていないようなエンティティも含めて、すべて、ドキュメント化するか 否かの設定。デフォルトは NO だが、 サンプルでは YES に設定した。
JAVADOC_AUTOBRIEF YES に設定すると、JavaDoc スタイルの簡易説明、すなわち、 コメントの一行目から最初のドット (.) までを簡易説明として扱うというスタイルが採用される。 デフォルトでは、明示的に @brief を記述する、Qt スタイルである。 サンプルでは YES に設定した。
WARN_FORMAT 警告を表示する場合のフォーマットを設定する。サンプルでは、 "$file:$line: $text" になっている。
INPUT 入力となるソースファイル(群)の名前、または、 それらが存在するディレクトリ(群)の名前を設定する。 サンプルでは、単に . (カレントディレクトリ) になっている。
FILE_PATTERNS 前項の INPUT にディレクトリの指定がある場合、 doxygen への入力として使用するファイルをフィルタリングするための ファイル名パターンを設定する。サンプルでは、*.cpp *.h になっている。
INPUT_FILTER ファイルを処理する前に通すフィルタープログラムを指定する。 Unix-like な環境で Shift_JIS なファイルを処理したい場合は、 ここに nkf などを指定すればよい。 (後述の「日本語の扱い」を参照)
GENERATE_LATEX ドキュメントの形式として、LaTeX 形式での出力をするか否かを設定する。 デフォルトは YES だが、サンプルでは NO になっている。 他にも、HTML (YES)、RTF (NO)、man ページ (NO) の各形式による出力を指定できる (カッコ内はデフォルトの設定)。
HAVE_DOT グラフ表示ツールキット graphviz に含まれる dot というツールを使うかどうかを設定する。YES にした場合は、 path の通った場所に、dot ツールが存在しなければならない。 デフォルト設定は NO。サンプルでは YES になっている。