Doxyfile(拡張ツールの設定)

概要:Doxygenと組み合わせて機能拡張できるツール

nkf Network Kanji Filter

概要:漢字コード変換プログラム
連携:文字コードが混在するプロジェクトにて、 nkf のエンコードの自動検出機能を利用する。

以下、文字コード混在のソースコードファイル群を、全て nkfUTF-8 に変換して出力する設定。

Doxyfile(nkfにパスが通った状態で)
タグ 初期値 設定値 特性 補足
DOXYFILE_ENCODING   UTF-8 required 出力エンコーディング
INPUT_ENCODING   UTF-8 required 入力エンコーディング
INPUT_FILTER   nkf -w required 入力ファイルフィルター
FILTER_PATTERNS     implied pattern=filter のリスト
FILTER_SOURCE_FILES NO YES implied INPUT_FILTERをSOURCE_BROWSERのソースファイル作成時に適用するか
FILTER_SOURCE_PATTERNS     implied ファイルパターンごとにソースフィルタを指定(FILTER_SOURCE_FILESが有効の場合のみ)

Graphviz

概要:DOT言語のスクリプトで示されたグラフを描画するためのソフトウェアツール
連携:クラス図とかリッチにしたい場合
Doxyfile(Graphvizがないと有効にならない項目)
タグ 初期値 設定値 特性 補足
HAVE_DOT NO YES required Graphvizを使う場合YESを設定する
DOT_NUM_THREADS 0   implied スレッド数
TEMPLATE_RELATIONS NO   implied テンプレートとそのインスタンスの間の関係を表示
INCLUDE_GRAPH YES YES implied インクルード依存関係図
INCLUDED_BY_GRAPH YES YES implied インクルード元依存関係図
CALL_GRAPH NO YES implied 呼び出し依存関係図の生成。処理が重いことに注意
CALLER_GRAPH NO YES implied 呼び出し元依存関係図の生成。処理が重いことに注意
DOT_IMAGE_FORMAT png svg implied dot が生成するイメージのフォーマット。 (svg, png, jpg, gif)
INTERACTIVE_SVG NO YES implied インタラクティブなSVGを生成(IE9以上では、HTML_FILE_EXTENSIONをxhtmlに設定する必要あり)
DOT_PATH   "C:\Program Files (x86)\Graphviz2.38\bin" required Graphvizのパス
DOT_GRAPH_MAX_NODES 50   implied グラフに表示されるノードの最大数
MAX_DOT_GRAPH_DEPTH 0   implied dotが生成するグラフの最大深度
DOT_MULTI_TARGETS NO YES implied 実行速度がたぶん速くなる(Graphvizのバージョンが1.8.10以上の場合のみ有効)
DOT_CLEANUP YES   implied YES (デフォルト) で、様々な図を生成するのに使う、dot の中間ファイルを削除

Mscgen

参考

Mscgen

概要:
メッセージ·シーケンス·チャートを描画するためのソフトウェアツール
連携:
@mscコマンドを使えば、メッセージシーケンス図をdoxygenのコメント内で定義可能。
このコマンドがあると、doxygenは msgenツールを実行して図を作成し、ドキュメントに挿入する。
Doxyfile(Mscgen用の確認項目)
タグ 初期値 設定値 特性 補足
MSCGEN_PATH     implied mscgenツールのディレクトリを指定。空の場合は、デフォルトのサーチパスと想定する

HTML Help Workshop

参考

Microsoft HTML Help Downloads から、Htmlhelp.exe をダウンロード(Htmlhelpj.exe は日本語ヘルプファイル)

概要:複数の HTML ファイルを 一つの圧縮 HTML ファイル (.chm) に変換することができるコンパイラー
連携:Doxygen によって生成された全 HTML 出力から 一つの圧縮 HTML ファイル (.chm) を出力する
Doxyfile(HTML Help Workshopがないと有効にならない項目)
タグ 初期値 設定値 特性 補足
GENERATE_HTMLHELP NO YES required .chm ファイルを設定する場合YESを設定する
CHM_FILE   ../$(PROJECT_NAME).chm implied html 出力ディレクトリ以外にchmファイルを出力したい場合、ファイルの前にパスを追加
HHC_LOCATION   "C:\Program Files (x86)\HTML Help Workshop\hhc.exe" required HTML ヘルプコンパイラ (hhc.exe) の絶対パス
GENERATE_CHI NO   implied .chi インデックスファイルを生成する(YES)か、.chm ファイルにインクルードさせる (NO) か
CHM_INDEX_ENCODING     implied 文字コード
BINARY_TOC NO   implied バイナリの目次を生成する (YES)か、.chm ファイルの中に通常の目次を生成する (NO) か
TOC_EXPAND NO   implied HTML ヘルプドキュメントの目次とツリービューに、グループメンバーに対する拡張項目を追加

PlantUML

注釈

@java -jar C:\tools\plantuml\plantuml.8047.jar -charset UTF-8 %*

単独でPlantUMLを使用したい場合、パス通ったトコに上記内容(パスは適宜)の plantuml.bat を用意して、以下のように使う

C:\>plantuml test.pu
概要:UMLを描画するためのソフトウェアツール
Doxyfile(PlantUMLがないと有効にならない項目)
タグ 初期値 設定値 補足
PLANTUML_JAR_PATH     PlantUMLのパス
PLANTUML_INCLUDE_PATH     plantumlブロック内の !includeステートメントで指定されたファイルの検索パス