DoxyGen文档之八

最新推荐文章于 2025-07-22 14:32:21 发布

原创最新推荐文章于 2025-07-22 14:32:21 发布 · 1.9k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#文档 #postscript #distance #documentation #output #compiler

本文介绍了使用Doxygen在文档中添加公式的方法。要在HTML文档中包含公式，需安装编译器、DVI转PostScript工具和GhostScript解释器。添加公式有两种方式，分别是使用行内公式和独立显示的无编号公式，同时提到公式应在“math - mode数学模式”中有效，且Doxygen对公式拼写错误容错性较差。

第五章：添加公式

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 able 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.

有两种方式在文档中添加公式

1. Using in-text formulas that appear in the running text. These formulas should be put between 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$.

生成：

The distance between and is .

4. Unnumbered displayed formulas that are centered on a separate line. These formulas should 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]

生成:

公式应该在的“math-mode数学模式” 中是有效的

警告：

Currently, doxygen is not very fault tolerant in recovering from typos in formulas. It may have to be necessary to remove the file formula.repository that is written in the html directory to a rid of an incorrect formula