doxygen

プログラムのマニュアルを書くのがものすごく苦手です．関数名とか変数名とかは一応，意味を示すような名前(たとえば，処理した文数を表すならsent_cntとか)にしているのですが，やっぱり簡単な説明をつけないと後で困るのです．引数がよくわからなくなったり．戻り値がわからなくなったり．
　で，気になっていたんですけど，めんどくさくて使っていなかったdoxygenを使ってみました．最近は，binary for linux見たいのがあったりするので，とっつきの壁が下がっているようです．
　こことかこことかを見るとすぐ使えます．
　簡単な使い方をこちらに

binary for linuxをダウンロードして展開したら，rootで

% make install

でパスが通ってるところにコピー．
　まず下のコマンドを打ちます．

# doxygen -g [プロジェクト名]

すると[プロジェクト名].cfgというファイルができます．んで，こいつの中(PROJECT_NAMEとかPROJECT_NUMBERとかOUTPUT_LANGUAGEとかEXTRACT_ALL)をいじくります．あとは，cとかc++とかjavaとかその辺のソースファイルにコメントを書き込んでから

# doxygen [プロジェクト名].cfg

とすると，htmlとかlatexとかのディレクトリができています．
　中のindex.htmlをブラウザで開けば，素敵なマニュアルができているというわけです．以上自分のためのメモでした．