PC作業メモ: FreeBSDでdoxygenを使ってみる

2013年10月27日日曜日

まずはインストール。

# pkg_add -r doxygen

図を作成するためのツールをインストール。

# pkg_add -r graphviz

コンフィグファイルを生成する。

% doxygen -g <コンフィグファイル名>

生成したコンフィグファイルを編集する。

% vi <コンフィグファイル名>

コンフィグファイルで変更した箇所とメモ

PROJECT_NAME = <プロジェクト名>
OUTPUT_DIRECTORY = <出力先のディレクトリ>
CREATE_SUBDIRS = YES
OUTPUT_LANGUAGE = Japanese
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES

プライベートメソッドをドキュメント化する

INPUT = <ソースコードの場所>
RECURSIVE = YES

サブフォルダのファイルもINPUTにする

SOURCE_BROWSER = YES
INLINE_SOURCES = NO

モジュール一覧と一緒にソースを表示したい場合は「YES」を設定

REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
GENERATE_LATEX = NO

LATEXファイルは生成しない

MSCGEN_PATH = /usr/local/bin

シーケンスを使う場合はmscgenの場所を指定

HAVE_DOT = YES

図を描画するための設定(graphvizが必要)

DOT_FONTNAME = Sazanami Gothic

図で使用するために日本語のフォントを指定

CALL_GRAPH = YES
CALLER_GRAPH = YES

PC作業メモ