OpenShogiLibリファレンスマニュアル

マニュアルを読む

マニュアルの作り方

  • Doxygen http://www.doxygen.org をインストールする.バージョン1.3.6以降である必要がある.
    • その前に png, graphviz http://www.graphviz.org などをインストールしておくと,クラス図などを書いてくれる
    • php が入っていると,検索機能が使える
  • doxygen を実行する
    cd osl/doc
    make
  • osl/doc/html にできているはず

マニュアルの書き方

  • doxygen の文法
  • tips
    • 文は"." (ASCIIのピリオド)で区切る.(日本語の句点は見てくれないので)
    • 改段落をさせるには空行をいれる.
    • サンプルコードを載せる時は,@code, @endcode で囲む
    • 表紙を作るには @mainpage コマンドを使う
    • いざとなればhtmlのタグが使える
    • マクロの解説を書く時は念のためブロック内に @def macroname で対象を指定しておく.マクロをまるごと//でコメントアウトしてしまった場合に,マクロの次以降の行の説明と解釈されないように. これで解決したと思ったのは偶然らしい.
    • マクロをコメントアウトする時は,説明も同時にコメントアウトする.


[ 編集 | 凍結 | 差分 | バックアップ | 添付 | リロード ]   [ 新規 | ヘルプ ] http://gps.tanaka.ecc.u-tokyo.ac.jp/osl/index.php?%A5%EA%A5%D5%A5%A1%A5%EC%A5%F3%A5%B9%A5%DE%A5%CB%A5%E5%A5%A2%A5%EB トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2007-04-09 (月) 17:11:36 (3641d)