ReferenceManual

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

マニュアルを読む †

• マニュアル
• Daily buildのマニュアル

マニュアルの作り方 †

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

  cd osl/doc
  make

• osl/doc/html にできているはず

マニュアルの書き方 †

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