doxygen配置及使用手册.doc

Doxygen安装及使用手册 一 简介Doxygen可以C++， java等源代码中提取消息来生成帮助文档， API资料等以下，是在平台下的demo介绍。http://www.stack.nl/~dimitri/doxygen/index.htmldoxyen主页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 -zxvf doxygen-1.5.5.src.tar.gz会在当前目录下生成一个名字为doxygen-1.5.5的目录。 4 在自己的Home目录下建立一个doxygen目录，我们的doxygen以后就安装到这个目录下。 #mkdir doxygen 5 进入doxygen-1.5.5目录 #cd doxygen-1.5.5 6 安装：用—prefix选项制定安装目录为/home/lvq/doxygen，lvq为我的用户名，这里可以用~/doxygen代替。 #./configure –prefix ~/doxygen #make #make install 这样在~/doxygen 目录就安装好了doxygen软件 7 生成配置文件 #cd ~/doxygen/bin/ # ./doxygen –g 文件名 执行这个命令后就会生成一个制定名字的配置文件，这里我们不加文件名，只用./doxygen –g 生成默认配置文件Doxyfile。 四 如何使用Doxygen Doxygen可以从源代码中提取消息生成帮助文档，它是根据源代码中的特定注释来实现。所以，首先要给工程代码书写符合Doxygen格式的注释。 1 以sipproxy小工程为例 @file 档案的批注说明。 @author 作者的信息 @brief 用于class 或function的批注中，后面为class 或function的简易说明。 @param 格式为 @param arg_name 参数说明 主要用于函式说明中，后面接参数的名字，然后再接关于该参数的说明。 @return 后面接函数传回值的说明。用于function的批注中。说明该函数的传回值。 @retval 格式为 @retval value 传回值说明 主要用于函式说明中，说明特定传回值的意义。所以后面要先接一个传回值。然后在放该传回值的说明。 /home/lvq/self/sipproxy1/sipproxy-v1.04/目录下。这个代码是用C语言实现的。 其中的多行注释形式为/** … */，单行注释为///，对于其他语言注释形式略有不同。 以一个函数为例，说明如何书写注释 /** * @brief process the received sip message, then send it to the remote client. * @param buf a received sip message buffer. * @retval return TRUE if it successes, else return FALSE. */ int udp_process_message(char *precvstr) 因为一般一个工程项目中有很多模块，所以按模块分类显示效果会更好些。要生成模块需要特定的注释。以sipproxy为例，其中在sipproxy-v1.04/目录下又有两个子目录：layer2和layer3。Layer2/下面有main.c,file.c,file.h三个文件，layer3/下面有socket.c,socket.h两个文件。我们根据目录名生成两个模块。 要实现这个功能，就要借助于注释格式@defgroup，用它可以给源代码生成一个模块名.如下： 在main.c中，用/** @defgroup Layer2 */定义一个模块分组Layer2，再把其他两个文件file.c和file.h加入到这个分组中，可以用/** @weakgroup File @ingroup Layer2 */说明包含在Layer2模块中，//@{ 和 //@}对把要包含的代码加到这个分组中。 用同样的方法给Layer3分组。 2 配置文件Doxyfile Siproxy工程中的源代码已经注释好，但还必须合理配置文件Doxyfile（在安装的时候已经说明怎么生成此配置文件）。这里只配置需要的配置选项，其他配置选项，使