2007年08月08日
【プログラム】doxygen 1.5.3+Graphviz 2.14でプログラム仕様書を自動で作っちまえ!に挑戦w
仕事でドキュメントを作ったり
関連図なんかを作ったりしなきゃいけないみたいなので
いろいろ調べてみたですはい。
すると、doxygenというもので、
ソースのコメントの内容にタグを入れると
htmlでドキュメント化してくれるという話
JAVAだとjavadocというのがあるけども
なんと、javadocのタグも認識できるww
さらに、Graphviz も使うと、関連図までできてしまう優れものw
すばらしいw
まぁとにかく、いろいろメモを書いておきませう
――――――――――――
○インストール関係メモ
1.graphviz-2.14.exeをDLしてインストール
DL元はここ
2.doxygen-1.5.3-setup.exeをDLしてインストール
DL元はここ
――――――――――――
という感じで準備はこれでおk
しかしだ、問題は設定関係だったりする
とりあえず、今回いろいろ試してみて、
いい感じに仕上がったので、公開している。
FontMakerSampleをサンプルとして、提示しちゃうw サンプル一式
このサンプル一式を実際にdoxygenで
マニュアルを作ったのがこれだ!w
結構、感動だよww
まぁコメントの部分に説明埋め込むのは意外と手間だけども
慣れてくれば、苦にもならなそうな雰囲気ですじゃw
で、サンプルの使い方を説明してないw
――――――――――――
○サンプルの使い方メモ
1.サンプル一式を適当なところに解凍して、
"d.bat"をダブルクリック!
2.docFontMakerSampleというフォルダが勝手に作られる。以上!
――――――――――――
こんなんでいいのかなぁw
というか、ここまではこんなことができたZEEEE☆
ってだけで、本題はここからかなw
doxygenの起動方法とかは上のサンプルを軽くみてもらえれば
プログラマなら分かると思うのでいいのだけども
設定はわけわからんw
しかも、1.5.2あたりから設定ファイルの仕様が一部変更になったとかw
そいつはどんまいだよ先生w
一番問題だったのは、文字化け関係
SHIFT-JISにすればいいんですか?UTF-8ですか?むしろEUC-JPですか?と
意味不明、結果的には、どれでもなくて
CP932でしたw
CP932はSHIFT-JISのさらに細かい分類のひとつだとか
詳しくはわかりませんが、この日記にあって助かったわけですw
他の設定関係は、正直よくわかってないのだけども、ここを参考に作成
サンプルの中に、
default.conf:デフォルトのセッティング
doxygen.conf:今回いじりまくったもの
という感じになっとる
変更点はこんな感じ
――――――――――――
023行 DOXYFILE_ENCODING= UTF-8 ⇒ CP932 028行 PROJECT_NAME = ⇒"FontManagerSampleSource" 034行 PROJECT_NUMBER = ⇒ 1.0 041行 OUTPUT_DIRECTORY = ⇒ docFontMakerSample 062行 OUTPUT_LANGUAGE = English ⇒ Japanese 139行 JAVADOC_AUTOBRIEF= NO ⇒ YES 242行 EXTRACT_ALL = NO ⇒ YES 247行 EXTRACT_PRIVATE = NO ⇒ YES 252行 EXTRACT_STATIC = NO ⇒ YES 480行 INPUT = ⇒ . 487行 INPUT_ENCODING = UTF-8 ⇒ CP932 496行 FILE_PATTERNS = ⇒ .cpp *.h *.doc *.java 502行 RECURSIVE = NO ⇒ YES 774行 GENERATE_TREEVIEW= NO ⇒ YES 789行 GENERATE_LATEX = YES ⇒ NO
――――――――――――
というわけで、プログラムなメモでしたw