doxygen在项目中的实践

doxygen是个好东西，帮我们做了一件比较繁琐的事情——把代码转化成文档，这里我们用他来生成测试用例的文档 

使用doxygen要做一下面几件事情：

 

1. 安装graphviz ./configure --prefix=/home/admin/local/ && make -j 8 && make install
2. 安装doxygen 
3. 使用doxygen -g 生成一个默认的doxygen配置文件Doxyfile
4. 修改Doxyfile，修改方法如下：

@@ -26,13 +26,13 @@ DOXYFILE_ENCODING      = UTF-8

-PROJECT_NAME           =

+PROJECT_NAME           = parker  

-PROJECT_NUMBER         =

+PROJECT_NUMBER         = 1.3

@@ -52,7 +52,7 @@ PROJECT_LOGO           =

-OUTPUT_DIRECTORY       =

+OUTPUT_DIRECTORY       = ./doxygen  这个是输出文件的目录

@@ -328,17 +328,17 @@ SYMBOL_CACHE_SIZE      = 0

-EXTRACT_ALL            = NO

+EXTRACT_ALL            = YES  这个一定要改成yes

-EXTRACT_PRIVATE        = NO

+EXTRACT_PRIVATE        = YES  这个一定要改成yes

-EXTRACT_STATIC         = NO

+EXTRACT_STATIC         = YES  这个一定要改成yes

@@ -629,7 +629,7 @@ WARN_LOGFILE           =

-INPUT                  =

+INPUT                  =/home/admin/hudson/workspace/75793_parker1.3/parker-1.3/test/   非常重要，这个是源代码目录

@@ -653,7 +653,7 @@ FILE_PATTERNS          =

-RECURSIVE              = NO

+RECURSIVE              = YES  一定要改成YES，这个表示在文件夹中递归搜

@@ -1186,7 +1186,7 @@ SERVER_BASED_SEARCH    = NO 

-GENERATE_LATEX         = YES  

+GENERATE_LATEX         = NO 一般不是用latex，所以把latex关闭

@@ -1573,7 +1573,7 @@ HIDE_UNDOC_RELATIONS   = YES

-HAVE_DOT               = NO

+HAVE_DOT               = YES  这里一定要设置成YES，否则不能画图。另外dot的目录（就是graphviz的目录）要放到系统的PATH中