ドキュメントの書き方 のバックアップ(No.1)

• バックアップ一覧
• 差分 を表示
• 現在との差分 を表示
• ソース を表示
• ドキュメントの書き方 へ行く。
  • 1 (03.30 (金) 18:23:58)

開発者向け情報

方針

• 新たな作業を始めるときは、dev at springhead.info MLに情報を流しましょう。

Springheadのドキュメント

Doxygenを使って作ります。Springheadのドキュメントには、

• ユーザ向けドキュメント
• ライブラリ実装者向けドキュメント の2つがあります。さらに、ユーザ向けドキュメントはコンパイル時間が長いので、 include/docsrc以下だけ または、 src/Samples だけで一部を作れるようにしてあります。

Doxygenについて

• マニュアル：http://www.doxygen.jp/manual.html Springhead2/doc にもあります。
• SpringheadのDoxygenには独自拡張があります。
  • \section, \subsection を使うと、名前の前に自動で章番号がつきます。
  • \contents で、そのページの目次　◇ Contents ◇ ができます。

各ドキュメントのコンパイル方法

• include/SpringheadDoc.bat を実行すると、 include/Springhead.doxy に基づいて ユーザ向けドキュメントを include/html/index.html と Springhead.chm(Springheadのトップフォルダ)に作ります。サンプルのドキュメントも生成されます。
• include/docsrc/docsrcDoc.bat を実行すると docsrc.doxy に基づいて、docsrc以下のファイルだけをコンパイルして、ユーザ向けドキュメントの一部をinclude/html/index.html と　include/docsrc/springhead_docsrc.chm に作ります。
• src/Samples/SamplesDoc.bat を実行すると SamplesDoc.doxy に基づいてサンプルプログラムだけについてのドキュメントを

  src/Samples/html/index.html と src/Samples/Samples.chm に作ります。

• src/SpringheadImpDoc.bat を実行すると ライブラリ開発者向けドキュメントが、src/html/index.html と src/SpringheadImp.chm にできます。
• src と include には、試しに一部のファイルだけをコンパイルするときに便利に使えるように、 TempDoc.bat と temp.doxy が用意してあります。

ユーザー向けドキュメントの作成手順

• include/docsrc にファイルを足したり、編集したりしてドキュメントを書きます。
• 書式やリンクがきちんと出来ているか確認します。
  • ドキュメントが正しく出来たかを確かめるためには、 docsrc/docsrcDoc.bat と src/Samples/SamplesDoc.bat を使うとよいと思います。
  • 現状、chm ファイルは互いにリンクされません。リンクの確認は html/index.htmlの方で行ってください。

担当

1. FrameworkによるSpringheadプログラミング（時崎)
   • SpringHeadのための初期設定
   • Frameworkを用いて物理シーンを作成
   • Box,Sphereの作成
   • BallJoint，HingeJointの作成
     
   • ジョイントの説明をユーザーズガイドに作成(花岡)
     • ジョイントの作成に関する注意（ヒンジジョイントの座標系の取扱など)
     • ジョイントの制御モード変更
     • ジョイントの拘束の設定方法
2. キャラクターの作成および制御(三武)
   
3. Xファイルを用いたシーン作成(松永)
   • PH,GRシーンの説明
   • Xファイルの作成方法
   • Xファイルのロード
     
4. 力覚インタフェースへの適応(須佐）
   • SPIDAR
   • FALCON