式のインクルード

Doxygen では、の式を出力することができます。 (HTML と出力でのみ動作します。 RTF や man ページ出力では動作しません。) HTML ドキュメントに式を (画像として) インクルードするためには、以下のツールをインストールしておく必要があります。

latex: コンパイラ。式を解析するのに必要です。作者は、teTeX 1.0 ディストリビューションを使用してテストしました。
dvips: DVI ファイルを PostScript ファイルに変換するツール。作者は、Radical Eye software のバージョン 5.92b を使用してテストしました。
gs: PostScript ファイルをビットマップに変換する GhostScript インタプリタ。作者は、Aladdin GhostScript 8.0 を使用してテストしました。

上記のツールが不要な方法に、MathJaxがあります。設定ファイルで、USE_MATHJAX を有効にすれば、LaTeX式がそのままの形でHTMLにコピーされます。そして、クライアントサイドのjavascriptが解析して、(インタラクティブな)画像に変換します。

ドキュメントに式をインクルードするには 3通りの方法があります。

本文中に挿入する式。式は、\f$ コマンドのペアで囲まなければなりません。
```
  \f$(x_1,y_1)\f$ と \f$(x_2,y_2)\f$ の間の距離は \f$\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}\f$。
```
の処理結果は次のようになります。

との間の距離は $\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}$ 。

独立した行に中央揃えで表示される、番号無しの式。これらの式は、\f[ と \f] コマンドで囲まなければなりません。例:

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

結果:

$|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|$

算術環境内にない式などの latex 要素は、\f{environment} を使って指定できます。ここで environment とは環境の名前で、\f} コマンドで終了させます。等式の配列を例にします。

   \f{eqnarray*}{
        g &=& \frac{Gm_2}{r^2} \\ 
          &=& \frac{(6.673 \times 10^{-11}\,\mbox{m}^3\,\mbox{kg}^{-1}\,
              \mbox{s}^{-2})(5.9736 \times 10^{24}\,\mbox{kg})}{(6371.01\,\mbox{km})^2} \\ 
          &=& 9.82066032\,\mbox{m/s}^2
   \f}

この指定の結果:

$\begin{eqnarray*} g &=& \frac{Gm_2}{r^2} \\ &=& \frac{(6.673 \times 10^{-11}\,\mbox{m}^3\,\mbox{kg}^{-1}\, \mbox{s}^{-2})(5.9736 \times 10^{24}\,\mbox{kg})}{(6371.01\,\mbox{km})^2} \\ &=& 9.82066032\,\mbox{m/s}^2 \end{eqnarray*}$

最初２つのコマンドでは、の算術モードで有効なコマンドが式に使われているかどうか確認してください。３つめのコマンドでは、指定の環境で有効なコマンドがセクション内で使われていることを確認してください。

警告: 現状、doxygen は、式中での誤植から回復について、あまり耐故障性が高くありません。 html ディレクトリに出力されたファイルformula.repository を削除して、不正な式を取り除く必要も出てくるでしょう。

次のセクションに行く / インデックスに戻る