1.安装doxygen(2)
2.配置Doxygen工作环境(2)
3.程序源码文档化(3)
4.程序文档生成(4)
5.Doygen集成到codeBlocks(4)
5.1配置步骤(4)
5.2使用:(4)
1.安装doxygen
安装包doxygen-1.7.4.linux.bin.tar.gz
命令:
1)tarxvfzdoxygen-1.7.4.linux.bin.tar.gz
2)cddoxygen-1.7.4
3)./configure
4)make
5)makeinstall
安装后需留心下doxyg的路径,比如:/usr/bin/doxygen
2.配置Doxygen工作环境
步骤:
6)步入项目目录(test为例说明)cdtest/
7)生成配置文件Doxygen–g
●默认生成的配置文件名为"Doxyfile",也可以采用"doxygen-gyour-cfg-filename"命令格式指定所生
成的配置文件名。如无特殊须要,采用默认的配置文件名即可。
●Doxyfile文件内容十分多,大约1000多行,不过其中约4/5都是注释,每位配置选项都有一段详尽
的注释。日后,假如对Doxygen各配置选项的意义有一定了解,可以在生成配置文件的命令中添加"-s"
选项,生成不含注释的配置文件,操作如下:$doxygen-s-g
3)配置文件的相应设置,这儿早已有个模板Doxyfile(test文件夹下),可以按照须要修改相应设置
#项目名称,将作为于所生成的程序文档首页标题
PROJECT_NAME=“Test
#文档版本号,可对应于项目版本号,比如svn、cvs所生成的项目版本号
PROJECT_NUMBER="1.0.0
#程序文档输出目录
OUTPUT_DIRECTORY=doc/
#程序文档语言环境
OUTPUT_LANGUAGE=Chinese
#若果是制做C程序文档linux 枚举文件,该选项必须设为YES,否则默认生成C++文档格式
OPTIMIZE_OUTPUT_FOR_C=YES
#对于使用typedef定义的结构体、枚举、联合等数据类型,只根据typedef定义的类型名进行文档化
TYPEDEF_HIDES_STRUCT=YES
#在C++程序文档中,该值可以设置为NOlinux系统编程,而在C程序文档中,因为C语言没有所谓的域/名子空间这样的概念,所以此处设置为YES
HIDE_SCOPE_NAMES=YES
#让doxygen静悄悄地为你生成文档,只有出现警告或错误时,才在终端输出提示信息
QUIET=YES
#只对头文件中的文档化信息生成程序文档
FILE_PATTERNS=*.h
#递归遍历当前目录的子目录,找寻被文档化的程序源文件
RECURSIVE=YES
#示例程序目录
EXAMPLE_PATH=example/
#示例程序的头文档(.h文件)与实现文档(.c文件)都作为程序文档化对象
EXAMPLE_PATTERNS=*.c
*.h
#递归遍历示例程序目录的子目录,找寻被文档化的程序源文件
EXAMPLE_RECURSIVE=YES
#容许程序文档中显示本文档化的函数互相调用关系
REFERENCED_BY_RELATION=YES
REFERENCES_RELATION=YES
REFERENCES_LINK_SOURCE=YES
#不生成latex格式的程序文档
GENERATE_LATEX=NO
#在程序文档中容许以图例方式显示函数调用关系,前提是你早已安装了graphviz软件包
HAVE_DOT=YES
CALL_GRAPH=YES
CALLER_GRAPH=YES
#让doxygen从配置文件所在的文件夹开始,递归地搜索所有的子目录及源文件
RECURSIVE=YES
#在最后生成的文档中,把所有的源代码包含在其中
SOURCEBROWSER=YES
$这会在HTML文档中,添加一个侧边栏,并以树形结构显示包、类、接口等的关系
GENERATETREEVIEW=ALL
3.程序源码文档化
打算好Doxygen的工作环境后,就须要依照Doxygen所定义的注释规则,对程序源码进行文档化。换句话说linux查看进程,就是在对程序源码添加注释时,要根据Doxygen的游戏规则来搞。
Doxygen的注释类型可分为:
●行间注释:注释句子不与程序源码出现在同一行,主要用于注释头文件中出现的结构体(struct)、枚举
(enum)、联合(uion)等数据类型,以及程序插口的功能与使用约定;
●行内注释:注释句子与程序源码出现在同一行内,主要用于代码的局部注释。
注释的种类有好多,下边是其中的一种:
Doxygen认可的行间注释标记见下例:
/**
*这是行间注释标记示例
*/
Doxygen认可的行内注释标记见下例:
typedefstruct{
doublecoord[3];///这是行内注释示例
}M2_3D_Point;
4.程序文档生成
如今开始生成程序文档,将终端的工作目录定位在test目录,之后键入:
$doxygenyour-cfg-filename
your-cfg-filename是Doxygen配置文件名,若果是使用"doxygen-g"生成的配置文件——Doxyfile,这么可以在终端里仅键入"doxygen"命令即可生成程序文档。
生成的文档坐落test/doc/html目录中,使用浏览器打开该目录中的index.html文件,即可看见自己的工作成果。
5.Doygen集成到codeBlocks
5.1配置步骤
在codeBlocks工作界面中,Tools->Configuretools->Add
Name:doxygen
Executable:/usr/bin/doxygen
Parameters:配置文件名,(假如doxygen–g生成的默认配置文件,在这儿不须要写)
Workingdirectory:test(要生成程序文档的项目路径)
5.2使用:
当须要生成程序文档时:Tools->doxygen即可。生成的文档坐落test/doc/html目录中,使用浏览器打开该目录中的index.html文件linux 枚举文件,即可看见自己的工作成果