Doxygenの使い方
Doxygen(1.5.4)によってサクラエディタのソースコードからドキュメントを生成する方法を説明します。
必要なもの
- Doxygen
- Doxygenの設定ファイル
- Graphviz
- サクラエディタのソースコード
Doxygenはソースコードからドキュメントを生成するツールです。
Doxygenは
http://www.doxygen.org/ から入手してください。
Windows用バイナリもダウンロードできます。
インストールを行い、インストールしたディレクトリの bin/ にパスを通してください。
Doxygenを使用するには設定ファイルが必要です。
Doxygenに付属のDoxywizardを使用して作成することができます。
サクラエディタ用のサンプル設定ファイルを用意していますのでご利用ください。
doxygen-sample.zip
各種の図を出力するためにはGraphviz(dot)というツールが必要です。
Graphvizは
http://www.graphviz.org/ から入手してください。
Windows用バイナリもダウンロードできます。
インストールを行い、インストールしたディレクトリの bin/ にパスを通してください。
図を出力しない場合、Graphvizは不要です。
設定
Doxygenを使用するには設定ファイルが必要です。
Doxywizardで作成するか、コマンド Doxygen.exe -g を実行すると設定ファイルを作成することができます。
サクラエディタ用のサンプル設定ファイルを用意していますので、面倒な方はサンプル設定ファイルを元に適宜修正してください。
- 文字コードを指定する(SHIFT_JISだと文字化けします)
DOXYFILE_ENCODING = CP932
INPUT_ENCODING = CP932
PROJECT_NAME = Sakura-Editor
PROJECT_NUMBER = "Unicode branch rXXX"
HAVE_DOT = YES
INPUT = sakura_core
RECURSIVE = YES
OUTPUT_DIRECTORY =
TAB_SIZE = 4
FILE_PATTERNS = *.cpp *.c *.h *.hh HowToCompile.txt
EXTRACT_PRIVATE = YES
生成
サクラエディタのソースコードを展開します。
次にDoxygen設定ファイルをソースコードを展開したフォルダ(sakura, sakura_core, resource, btoolのフォルダが入っているフォルダ)にコピーします。
コマンドプロンプトを開いてカレントディレクトリをソースコードを展開したフォルダに移動します。
Doxygenを実行するとhtmlディレクトリにHTMLによる解説(トップページはindex.html)が生成されます。
コメントの書き方
サンプルプロジェクトを用意しました。
コメントの書き方と表示のされ方の参考にしたり、テスト用に利用してください。
コメントの書き方は一通りではありません。
コメントの書き方の詳しい説明は
http://www.doxygen.jp/ のマニュアルを参照してください。
次のコメントを書くことを推奨します。
- ファイルの説明、著者、履歴(@file,@author,@date)
- 関数、引数、戻り値の説明(@brief,@param,@return,@retval)
- クラス、構造体、列挙型、メンバ変数等の説明(@brief,...)
- その他開発者に伝えたい特記事項や覚書(@note,@todo)
CHMファイルの生成
DoxygenでCHMファイルを生成するのに必要なHTML Help Workshopのプロジェクトファイルを生成することができます。
GENERATE_HTMLHELP = YES
CHM_FILE = sakura.chm
#HHC_LOCATION = hhc.exe
HHC_LOCATION =
Doxygen1.5.4では出力ファイルがすべてUTF-8となっています。
一方、HTML Help WorkshopはSHIFT_JISしか受け付けません。
そこで、Doxygen1.5.4でCHMファイルを生成する場合は、コンパイルする前に*.hhc,*.hhpファイルの文字コードをSHIFT_JISに変換する必要があります。
nkf --windows --overwrite index.hhp
nkf --windows --overwrite index.hhc
なお、*.htmlファイルについてはそのままで大丈夫ですが、"Compile full-text search information"のチェックをはずす必要があります。
このオプションを利用する場合は、*.htmlファイルもSHIFT_JISに変換してください。
さらに、HTMLファイル内のmetaタグも修正してください。
リンク
最終更新：2007年11月18日 16:15
