Chapter 5: Add Formula
Doxygen Allows you to put
Formulas in the output (this works only for the html and
Output, Not for the RTF NOR for the man page output). To be aable to include formulas (as images) in the html documentation, you will also need To have the following tools installed
· LaTex: The
Compiler, Needed to Parse The Formulas. To Test i Have Used The Tetex 0.9 Distribution.
· DVIPS: a Tool to Convert DVI Files to PostScript Files I have used version 5.86 from radical eye software for testing.
· GS: The Ghostscript Interpreter for Converting PostScript Files To Bitmaps. I have used Aladdin Ghostscript 5.10 for testing.
There are two ways to add formulas in the document
1. Using in-text formulas That Appear in the Running Text. These formulas shouth be putbetween a pair of / f $ commands, so
2. The Distance BetWeen / F $ (x_1, y_1) / f $ and / f $ (x_2, y_2) / f $ IS
3. / f $ / SQRT {(x_2-x_1) ^ 2 (y_2-y_1) ^ 2} / f $.
generate:
The distance badween
and
IS
.
4. Unnumbered Displayed Formulas That Are Centered on a Separate Line. These formulas shouth be put betWeen / f [and / f] Commands. An Example:
5. / f [
6. | i_2 | = / left | / int_ {0} ^ T / PSI (T)
7. / Left / {
8. U (a, t) -
9. / INT _ {/ gamma (t)} ^ a
10. / Frac {d / theta} {k (/ Theta, T)}
11. / INT_ {a} ^ / THETA C (/ xi) U_T (/ Xi, T) /, D / Xi
12. / Right /} DT
13. / Right |
14. / f]
generate:
Formula should be
"Math-Mode Mathematical Mode" is effective
caveat:
