Doxygen用法(肝拜下风 树大招风 扫水吧)

免费打工仔

Doxygen用法
Doxygen可以通过命令行的方式来操作，可以通过在命令行doxygen命令后面加上--help参数来得到这个程序命令行调用方法的大体描述。




所有的操作方法都遵照以下的格式，首先有一个"-"符号作为开始，然后紧跟着表示这种操作的一个字母以及一个或者更多的此种操作所需要的参数。




通常来说，为你的工程来产生一个手册通常包括下面的步骤：

1、首先在你的源代码中加入用于产生文档的特殊标记（请参照Special documentation blocks in Python）。
2、通过命令行调用doxygen -g制作一个你所需要的配置文件(参照Configuration)，具体格式为：
doxygen - g <config_file>
3、编辑上一步骤中产生的配置文件，让其能匹配你的工程。在这个配置文件里面你可以指定包括输出文件和一系列操作信息等参数。
4、基于上面的配置文件，调用doxygen来产生你的文档：
doxygen <config_file>

如果你已经有了一个早期版本Doxygen的配置文件，可以通过当前版本doxygen和-u参数来对其进行更新操作。

doxygen -u <config_file>

在执行了上面的更新操作之后，所有原有的设置都被保留，而新版本支持的属性会被设置成为默认值。这里需要注意的是，原有配置文件将会被这个操作所产生的新文件所覆盖。


如果你希望可以调整最终输出结果的样式，doxygen允许你改变默认的风格、网页的头部和尾部，具体的实现方式为：

对于HTML输出，你可以通过下面的命令来改变默认的头部(参照HTML_HEADER)、默认的网页尾部(see HTML_FOOTER)、以及默认情况下的网页风格(参照HTML_STYLESHEET):
doxygen -w html header.html footer.html stylesheet.css
对于LaTeX输出，我们可以通过refman.tex(参照LATEX_HEADER)来指定头部，然后通过一个普通的doxygen.sty文件来指定其样式，操作如下：
doxygen -w latex header.tex doxygen.sty

如果你不需要使用默认的设置操作（例如使用pdflatex），你需要构造一个配置文件来进行正确的设置，并作为一个外部参数来使用。




对于RTF输出，你可以指定自己的样式文件（参照RTF_STYLESHEET_FILE）：
doxygen -w rtf rtfstyle.cfg

注意:

如果你希望文档中并不包含所有的元素，可以使用-s操作。他可以联合-u操作一同使用，来在已经存在的配置文件中增加或者剥离文档。如果你希望把一个配置文件作为bug的载体来发给我的话请用-s操作处理一下！
如果希望读写操作标准的input/output代替from/to一个文件，对文件名使用-。



原文 --免费打工仔 15:56 2007年5月1日 (CST)

取自"http://ogre3d.cn/wiki/index.php?title=%E5%85%8D%E8%B4%B9%E6%89%93%E5%B7%A5%E4%BB%94oxygen%E7%94%A8%E6%B3%95"

xpertsoft

Doxygen是好东西。我曾经用它来生成过Unreal2部分代码的文档，导读非常方便。

大树懒

哈哈,厉害,真是好东西;)

lingjingqiu

doxygen的向导模式搭配高级模式也是不错的，不用敲命令行输入一坨坨参数了。。。

xpertsoft

又个GUI界面的。

lingjingqiu

。。。GUI也不错。。。我命令行实在用的不熟练。。。