doxygen配置及使用手册11 - 说明文书.docx

eremoteclient.*@parambufareceivedsipmessagebuffer.关键变量、宏的定义，在其前或者后使用@brief定义其简要说明，空一行后继续写其详细的注释即可。对函

eremoteclient.*@parambufareceivedsipmessagebuffer.

关键变量、宏的定义，在其前或者后使用@brief定义其简要说明，空一行后继续写其详细的注释即可。对函

atesectionbecauseitcontainsmemberswithdifferentpro

*/块如果你更喜欢Cstyle注释。需要注意的是所有的members必须写在其中。在//@{之前还可

Doxygen安装及使用手册

一简介

Doxygen可以从C，C++，java等源代码中提取消息来生成帮助文档，API资料等二下载Doxygen

以下，是在linux平台下的demo介绍。

http://www.stack.nl/~dimitri/doxygen/index.html

doxyen主页去下载doxygen-1.5.5.src.tar.gz

三Doxygen安装

安装doxygen-1.5.5.src.tar.gz

1把下载好的doxygen-1.5.5.src.tar.gz拷到自己想要的目录中，我放到了自己的Home目录下。

2进入相应的目录：本例是在自己的home目录下

3解压

#tar-zxvfdoxygen-1.5.5.src.tar.gz会在当前目录下生成一个名字为doxygen-1.5.5的目录。

4在自己的Home目录下建立一个doxygen目录，我们的doxygen以后就安装到这个目录下。#mkdirdoxygen

5进入doxygen-1.5.5目录#cddoxygen-1.5.5

6安装：用—prefix选项制定安装目录为/home/lvq/doxygen，lvq为我的用户名，这里可以用~/doxygen代替。

#./configureprefix~/doxygen

#make

#makeinstall

这样在~/doxygen目录就安装好了doxygen软件

7生成配置文件

#cd~/doxygen/bin/

#./doxygeng文件名

执行这个命令后就会生成一个制定名字的配置文件，这里我们不加文件名，只用./doxygen

g生成默认配置文件Doxyfile。

四如何使用Doxygen

Doxygen可以从源代码中提取消息生成帮助文档，它是根据源代码中的特定注释来实现。所以，首先要给工程代码书写符合Doxygen格式的注释。

1以sipproxy小工程为例

@file

@file

@author

@brief

档案的批注说明。

作者的信息

用于class或function的批注中，后面为class或function

的简易说明。

管在.h已经做了group

管在.h已经做了group的memberfunctions放在一起。）Example:/**@def

NERATETREEVIEWTREEVIEWWIDTHGENERATELATEXLATEXOUTPU

定的格式撰写doxygen认识的注释，并能够使用doxygen方便快捷的生成对应的文档，不过注释中应

仅这样是不够的或者这种缺省的方法是错误的。例如你认为有不同（语法）的类型需要归入同一个group（语

@param

@param

@return

◎defgroup

@retval

格式为

@paramarg_name参数说明

主要用于函式说明中，后面接参数的名字，然后再接关于该参数的说明。

后面接函数传回值的说明。用于function的批注中。说明该函数的传回值。

可以用这个注释格式给源代码文件分组

格式为

@retvalvalue传回值说明

主要用于函式说明中，说明特定传回值的意义。所以后面要

先接一个传回值。然后在放该传回值的说明。

1)这个工程在/home/lvq/self/sipproxy1/sipproxy-v1.04/目录下。这个代码是用C语言

实现的。

其中的多行注释形式为/***/，单行注释为///，对于其他语言注释形式略有不同。

2)以一个函数为例，说明如何书写注释/**

*@briefprocessthereceivedsipmessage,thensendittotheremoteclient.

*@parambufarecei