doxygen笔记

  

一,新建一个doxyfile.conf文件以后,必须在以下的这些地方进行修改.

PROJECT_NAME：在网页上显示的项目的名称

PROJECT_NUMBER:显示的项目的版本号

OUTPUT_LANGUAGE:输入的语言

DOXYFILE_ENCODING:根据输出的语言选择编码

http://www.gnu.org/software/libiconv 到这个网站上去找对应的语言的编码

JAVADOC_AUTOBRIEF:根据注释的格式选择,如果注释是javadoc格式的,将这个选项设置为TRUE

INPUT:项目所在的目录

FILE_PATTERNS:文件的格式,注意空格是必须的

       *.h *.cpp 或者 *.h /

                     *.cpp

HAVE_DOT:是否显示的类的层次结构图,如果设置为TRUE,必须要安装生成类图的软件.

ALPHABETICAL_INDEX:是否生成按字母顺序排列类的选项卡,在网页上

OUTPUT_DIRECTORY:输出路径。产生的文件会放在这个路径之下。如果没有填这个路径，将会以目前所在路径来作为输出路径。

RECURSIVE:子目录是否被处理

HTML_OUTPUT: HTML文件的输出目录。这是一个相对路径，所以实际的路径为OUTPUT_DIRECTORY加上HTML_OUTPUT。这个设定预设为html。 

 

二,常用的指令

@file 对一个文件进行说明

@author              作者的信息

@brief               用于class 或function的批注中，后面为class 或function的简易说明。

也可以不用@brief,简要说明和详细说明之间必须用一个空格格开.或者用”.”

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

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

@retval              格式为@retval value 传回值说明主要用于函式说明中，说明特定传回值的意义。所以后面要先接一个传回值。然后在放该传回值的说明。

这个主要用于,当一个函数的返回值有多种情况时对每一种情况进行说明

 

@date        对日期进行说明

@attention       对需要注意的地方进行说明.

 

 

还有,如果没给一个类写注释,那么这个类在生成的html文件中不会体现出来,只有写了注释,才会在HTML文件中看到这个类,另外,对于私有的成员函数或属性,不会体现出来,公司的成员才会在HTML中生成