doxygen配置及使用手册

《doxygen配置及使用手册》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、Doxygen安装及使用手册一简介Doxygen可以从C，C++，java等源代码中提取消息来生成帮助文档，API资料等二下载Doxygen以下，是在linux平台下的demo介绍。http://www.stack.nl/~dimitri/doxygen/index.htmldoxyen主页去下载doxygen-1.5.5.src.tar.gz三Doxygen安装安装doxygen-1.5.5.src.tar.gz1把下载好的doxygen-1.5.5.src.tar.gz拷到自己想要的目录中，我放到了自己的Home目录下。2进入相应的目录：本例是在自己的home目

2、录下3解压#tar-zxvfdoxygen-1.5.5.src.tar.gz会在当前目录下生成一个名字为doxygen-1.5.5的目录。4在自己的Home目录下建立一个doxygen目录，我们的doxygen以后就安装到这个目录下。#mkdirdoxygen5进入doxygen-1.5.5目录#cddoxygen-1.5.56安装：用—prefix选项制定安装目录为/home/lvq/doxygen，lvq为我的用户名，这里可以用~/doxygen代替。#./configure–prefix~/doxygen#make#makeinstall这样在~/doxyge

3、n目录就安装好了doxygen软件7生成配置文件#cd~/doxygen/bin/#./doxygen–g文件名执行这个命令后就会生成一个制定名字的配置文件，这里我们不加文件名，只用./doxygen–g生成默认配置文件Doxyfile。四如何使用DoxygenDoxygen可以从源代码中提取消息生成帮助文档，它是根据源代码中的特定注释来实现。所以，首先要给工程代码书写符合Doxygen格式的注释。1以sipproxy小工程为例@file档案的批注说明。@author作者的信息@brief用于class或function的批注中，后面为class或function的

4、简易说明。@param格式为@paramarg_name参数说明主要用于函式说明中，后面接参数的名字，然后再接关于该参数的说明。@return后面接函数传回值的说明。用于function的批注中。说明该函数的传回值。◎defgroup可以用这个注释格式给源代码文件分组@retval格式为@retvalvalue传回值说明主要用于函式说明中，说明特定传回值的意义。所以后面要先接一个传回值。然后在放该传回值的说明。1)这个工程在/home/lvq/self/sipproxy1/sipproxy-v1.04/目录下。这个代码是用C语言实现的。其中的多行注释形式为/**…*

5、/，单行注释为///，对于其他语言注释形式略有不同。2)以一个函数为例，说明如何书写注释/***@briefprocessthereceivedsipmessage,thensendittotheremoteclient.*@parambufareceivedsipmessagebuffer.*@retvalreturnTRUEifitsuccesses,elsereturnFALSE.*/intudp_process_message(char*precvstr)3)因为一般一个工程项目中有很多模块，所以按模块分类显示效果会更好些。要生成模块需要特定的注释。以sip

6、proxy为例，其中在sipproxy-v1.04/目录下又有两个子目录：layer2和layer3。Layer2/下面有main.c,file.c,file.h三个文件，layer3/下面有socket.c,socket.h两个文件。我们根据目录名生成两个模块。要实现这个功能，就要借助于注释格式@defgroup，用它可以给源代码生成一个模块名.如下：在main.c中，用/**@defgroupLayer2*/定义一个模块分组Layer2，再把其他两个文件file.c和file.h加入到这个分组中，可以用/**@weakgroupFile@ingroupLayer

7、2*/说明包含在Layer2模块中，//@{和//@}对把要包含的代码加到这个分组中。用同样的方法给Layer3分组。2配置文件DoxyfileSiproxy工程中的源代码已经注释好，但还必须合理配置文件Doxyfile（在安装的时候已经说明怎么生成此配置文件）。这里只配置需要的配置选项，其他配置选项，使用者可以根据自己的需要进行配置。#vi~/doxygen/bin/DoxyfilePROJECT_NAME=SipProxy（项目名称）PROJECT_NUMBER=1.0（相当于版本号）OUTPUT_DIRECTORY=/home/lvq/outputdoxy