Inclure des formules

---

Doxygen vous permet de mettre des formules dans la sortie (cela ne fonctionne que pour la sortie HTML, LATEX et RTF). Pour pouvoir inclure des formules (sous forme d'images) dans la documentation HTML et RTF, vous devrez également avoir les outils suivants installés :

• latex : le compilateur , nécessaire pour analyser les formules. Pour tester, j'ai utilisé la distribution teTeX 1.0.
• dvips : un outil pour convertir des fichiers DVI en fichiers PostScript. J'ai utilisé la version 5.92b du logiciel Radical Eye pour les tests.
• gs : l'interpréteur GhostScript pour convertir des fichiers PostScript en bitmaps. J'ai utilisé Aladdin GhostScript 8.0 pour les tests.

Pour la sortie HTML, il existe également une solution alternative utilisant MathJax qui ne nécessite pas les outils ci-dessus. Si vous activez USE_MATHJAX dans la configuration, les formules latex seront copiées dans le HTML « telles quelles » et un JavaScript côté client les analysera et les transformera en images (interactives).

Il existe quatre façons d'inclure des formules dans la documentation.

1 . Utilisation de formules dans le texte qui apparaissent dans le texte en cours. Ces formules doivent être placées entre une paire de commandes \f$, donc :

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

résultat :

2 . L'utilisation de formules qui apparaissent dans le texte en cours, contrairement à \f$, n'ouvrira pas explicitement le mode mathématique dans . Ces formules doivent être placées entre les commandes \f( et \f), donc :

The LaTeX and Tex logos are : \f</a>(\LaTeX \f) et \f(\TeX \f).

résultat :

The LaTeX and Tex logos are : et

3 . Formules affichées non numérotées et centrées sur une ligne distincte. Ces formules doivent être placées entre les commandes \f[ et \f]. Un exemple :

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

résultat :

4 . Les formules ou autres éléments latex qui ne se trouvent pas dans un environnement mathématique peuvent être spécifiés à l'aide de \f{environment}, où environment est le nom de l'environnement , la commande de fin correspondante est \f}. Voici un exemple de tableau d'équations :

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

ce qui donne :

Pour les première et troisième commandes, il faut s'assurer que les formules contiennent des commandes valides dans le mode mathématique de . La deuxième commande doit valider les commandes en mode texte qui fonctionnent également en mode mathématique lors de l'utilisation de USE_MATHJAX. Pour la quatrième commande, la section doit contenir une commande valide pour l'environnement spécifique.

Pour avoir la possibilité de définir vos propres commandes , par exemple pour des blocs de construction de formules ou une écriture cohérente de certains mots, l'option de configuration FORMULA_MACROFILE peut être utilisée. pour fournir un fichier avec des commandes . Ce fichier peut contenir les commandes \newcommand et \renewcommand et elles sont incluses dans les formules (version image et version MathJax) ainsi que dans la sortie générée (pour la génération PDF). Les commandes \newcommand (et \renewcommand) sont limitées à une version sans paramètres optionnels, donc seuls les types suivants sont pris en charge :

\newcommand{\cmd}{replacement}
\newcommand{\cmd}[nr]{replacement}

par exemple :

\newcommand{\E}{\mathrm{E}}
\newcommand{\ccSum}[3]{\sum_{#1}^{#2}{#3}}