doxygen 使用

    doxygen 支持c/c++/java/python/php等多种语言的提取, 支持html/rtf/latex/xml/man等多种方式的导出，效果比javadoc丰富。

 

一. 配置文件

    #doxygen -g   会在当前目录产生名称为 Doxygen 的默认配置文件，配置文件采用 key = value 这样结构，只需根据需要修改几项即可生成文档。下面几项比较重要：

 

PROJECT_NAME           = "Basic Sytle Test"		        #工程名称
OUTPUT_DIRECTORY       = ./html					#文档的生成目录
INPUT                  = test					#要生成文档的源文件目录

EXTRACT_ALL            = yes					#告诉doxygen,即使函数没有注释，也要提取
EXTRACT_PRIVATE        = yes					#提取私有成员信息
EXTRACT_STATIC         = yes					#提取静态成员信息
GENERATE_HTML          = YES					#导出html

    直接在该目录运行 doxygen 命令，会在html目录内生成文档

 

二. 注释格式

     doxygen支持多种注释格式（具体见example），包括QT和java风格的注释方式，个人比较习惯java注释方式

/**
 *@brief 通信测试类
 *@author kettas
 *@date 2014/12/22
 *@warning The program can't be run
 *@copyright Aotain Public Lisence
 */
class TcpService
{
public:
	/**
	 *@brief 无参构造函数
	 */
	TcpService();

	~TcpService();

public:
	/**
	 *@brief 新建流式socket
	 *@param port 通信端口
	 *@return 是否成功,0表成功，1表失败
	 */
	int add_socket(int port);

	/** An enum type. More details */
	enum EType {
		var1,  	/**< enum value 1 */
		var2	 /**< enum value 2 */
	};

private:
	int sock;
};

 

三. 效果