メインページ モジュール クラス階層 アルファベット順一覧 構成 ファイル一覧 構成メンバ ファイルメンバ 関連ページ

# Doxygenの使い方

## ローカライズされた適用ルール

- どのファイルまでコメントうつか
- どの程度のタグまでうつか
- コメントの自分フォーマット
- カテゴリごとの説明とかもトップページに
- 概要やダウンロードおよびライセンスもトップページへ
- 例題やTODO,バグ情報も
- トップページに書く内容を絞りこむ
- カテゴリをどうわりふる?
- カテゴリ以外はリンクポインタだけでもよい

- 短い説明は必ずつける
- 長い説明は必ずしもいらない
- paramとretvalはできるだけがんばる
- .ccはいらん
- .hhと見れるがクラスの説明には入らないように
- enumとtypedefとdefineもコメントうつ
- testsとexamples以下はあくまで例題としてしか含めない
- 目次から各カテゴリのクラスに飛べるように
- typdef クラスしてるやつは ちゃんと \class してやる

## Doxygen利用にあたってのメモ

数式は以下のようにして使用するのだけれど, LaTeX 知らないしらんやつはだめってことですね.

    \f[
      |I_2|=\left| \int_{0}^T \psi(t)
               \left\{
                  u(a,t)-
                  \int_{\gamma(t)}^a
                  \frac{d\theta}{k(\theta,t)}
                  \int_{a}^\theta c(\xi)u_t(\xi,t)\,d\xi
               \right\} dt
            \right|
    \f]

    The distance between \f$(x_1,y_1)\f$ and \f$(x_2,y_2)\f$ is
    \f$\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}\f$

The distance between and is .

latex ディレクトリで make するとエラーになってしまうので

    # vi /usr/share/texmf/web2c/texmf.cnf
       :
       :
    サイズの定義っぽいところを一桁ずつ増やす
       :
       :

としてあげました.わからないでしょ,フツー. むしろこれを直感的にやる自分が恐ろしい.