// -*- C++ -*-
// =====================================================================
/*!
//
//  \file doxygen.doxy
//  \brief CLDAQプロジェクトに於けるDoxygenの利用方法についての私的メモです.
//  \author Go IWAI <goiwai@users.sourceforge.jp>
//
//  $Id: doxygen.doxy,v 1.1.1.1 2003/11/02 05:57:32 goiwai Exp $
//  $Name: doxygen-1-01-00 $
//
//  $Log: doxygen.doxy,v $
//  Revision 1.1.1.1  2003/11/02 05:57:32  goiwai
//  CLDAQモジュールをDoxygenでドキュメント化するための設定ファイルやスクリ
//  プト,ドキュメントそのものを同梱します.
//
//
*/
// =====================================================================

/*!
  \page AboutDoxygen Doxygenの使い方


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


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

  \section AboutDoxygenMemo Doxygen利用にあたってのメモ
  \par
  数式は以下のようにして使用するのだけれど,
  LaTeX 知らないしらんやつはだめってことですね.

  \par
  \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]

  \par
  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$.

  \par
  latex ディレクトリで make するとエラーになってしまうので
  \verbatim
  # vi /usr/share/texmf/web2c/texmf.cnf
     :
     :
  サイズの定義っぽいところを一桁ずつ増やす
     :
     :
  \endverbatim
  としてあげました.わからないでしょ,フツー.
  むしろこれを直感的にやる自分が恐ろしい.

*/
