プロ ジェクトホーム >> トップページ >> 開発に参加したい方へ >> doxygenによる解説の生成
このページの最新版は以下の場所をご覧くださいhttp://sakura-editor.wiki.sourceforge.net/DoxygenHowto
doxygenによってSAKURAエディタのソースコード解説を生成する方法を説明します。
doxygen本体は http://www.doxygen.org から入手してください。Windows用Binaryもダウンロードできます。インストーラを実行して，インストールしたディレクトリ下ののbinにパス を通してください．
1.2.14以前のバージョン＋NKFでEUCを使う場合に比べて直接Shift-JISを出力した方が高速ですので，旧版を使ってい る方はバージョンアップをおすすめします．
nkfはnkf32というソフトがvectorからダウンロードできますので、これもパスの通ったフォル
ダに入れてください。(Ver. 1.2.13.1以降では不要です．)
各種の図を出力するためにはdot(Graphiz)というツールが必要です．こちらよ りWindowsバイナリをダウンロード＋インストールすればdoxygenから利用できます．
最新のソースコードはeGroups の共有フォルダにあります。
設定ファイルはdoxygen付属のdoxywizardで簡単に作成できます．
ソースコードを展開します。
次にdoxygen設定ファイルをソースコードを展開したフォルダ(sakura, sakura_core, resource,
btoolのフォルダが入っているフォルダ）に移動します。
コマンドプロンプトを開いてカレントディレクトリをソースコードを展開したフォルダに移動します。
doxygen を実行するとdocディレクトリにHTMLによる解説が生成されます。LaTeXやRTF版が欲しい人はdoxyfileを修正して生成を抑制しないよう にしてください。
WindowsのHTMLヘルプ用を作るためのファイルを生成するオプションも用意されています。