DoxygenHowto

開発に参加したい方へ＞doxygen＞使い方

doxygenの使い方

doxygenによってSAKURAエディタのソースコード解説を生成する方法を説明します。

必要なもの

1. doxygen本体
2. テキストエディタのソースコード
3. doxygen設定ファイル

doxygen本体は http://www.doxygen.org から入手してください。Windows用Binaryもダウンロードできます。インストーラを実行して，インストールしたディレクトリ下ののbinにパスを通してください．

1.2.14以前のバージョン＋NKFでEUCを使う場合に比べて直接Shift-JISを出力した方が高速ですので，旧版を使っている方はバージョンアップをおすすめします．

各種の図を出力するためにはdot(Graphiz)というツールが必要です．こちらよりWindowsバイナリをダウンロード＋インストールすればdoxygenから利用できます．

設定ファイルはdoxygen付属のdoxywizardで簡単に作成できます．

See also

http://www.doxygen.jp/manual.html

生成

ソースコードを展開します。

次にdoxygen設定ファイルをソースコードを展開したフォルダ(sakura, sakura_core, resource, btoolのフォルダが入っているフォルダ）に移動します。

コマンドプロンプトを開いてカレントディレクトリをソースコードを展開したフォルダに移動します。

doxygen を実行するとdocディレクトリにHTMLによる解説が生成されます。LaTeXやRTF版が欲しい人はdoxyfileを修正して生成を抑制しないようにしてください。

WindowsのHTMLヘルプ用を作るためのファイルを生成するオプションも用意されています。