linux下eclipse的doxygen插件集成

近期一直使用eclipse作为linux下的C++语言开发工具，发现真的是很值得推荐的好东西，具有完善的编辑编译环境，同时集成大量开发插件，使用方便：）

如果有不了解doxygen的同学我在这里简单介绍一下：Doxygen 是一个API文件产生工具，可将程序中的特定批注转换成为说明文件，类似于JAVA中的javadoc。适用于C/C++、C#、java等多种语言，具体注释语法在这里就不多介绍了，各位可参照网上资料，回头有时间我再进行整理，主要说明Doxygen在eclipse的集成及使用过程。

首先安装eclipse和eclipse-eclox.noarch插件： sudo yum install eclipse eclipse-eclox.noarch

安装完成eclipse启动后在工具栏中会出现@，如图所示：

在新项目中点击@会让用户创建新的配置文件，随后在项目中可以看见刚刚创建的doxfile文件。

针对doxyfile可进行编辑，主要有以下内容需关注：

• <OUTPUT_DIRECTORY>：必须在这里提供一个目录名，例如 /home/user1/documentation，这个目录是放置生成的文档文件的位置。如果提供一个不存在的目录名，doxygen 会以这个名称创建具有适当用户权限的目录。
• <INPUT>：这个标记创建一个以空格分隔的所有目录的列表，这个列表包含需要生成文档的 C/C++ 源代码文件和头文件。如果项目只有一个源代码根目录，其中有多个子目录，那么只需指定根目录并把<RECURSIVE> 标记设置为Yes。
• <FILE_PATTERNS>：在默认情况下，doxygen 会搜索具有典型 C/C++ 扩展名的文件，比如.c、.cc、.cpp、.h 和.hpp。如果 <FILE_PATTERNS> 标记没有相关联的值，doxygen 就会这样做。如果源代码文件采用不同的命名约定，就应该相应地更新这个标记。例如，如果项目使用.c86 作为C 文件扩展名，就应该在 <FILE_PATTERNS> 标记中添加这个扩展名。
• <RECURSIVE>：如果源代码层次结构是嵌套的，而且需要为所有层次上的 C/C++ 文件生成文档，就把这个标记设置为Yes。例如，请考虑源代码根目录层次结构 /home/user1/project/kernel，其中有 /home/user1/project/kernel/vmm 和 /home/user1/project/kernel/asm 等子目录。如果这个标记设置为Yes，doxygen 就会递归地搜索整个层次结构并提取信息。
• <EXTRACT_ALL>：这个标记告诉 doxygen，即使各个类或函数没有文档，也要提取信息。必须把这个标记设置为Yes。
• <EXTRACT_PRIVATE>：把这个标记设置为 Yes。否则，文档不包含类的私有数据成员。
• <EXTRACT_STATIC>：把这个标记设置为 Yes。否则，文档不包含文件的静态成员（函数和变量）。
• <OUTPUT_LANGUAGE>：默认 = English，文档语言（自动生成的文字部分），可以指定为Chinese。
• <DOXYFILE_ENCODING>：默认 = UTF-8，默认编码为UTF-8，这样可以支持中文。
• <PROJECT_NAME>：项目名称，多个单词需要使用引号(“”)。
• <PROJECT_NUMBER>：项目版本号。
  

也可以使用eclipse中集成的doxygen editor进行修改，基本上需要修改的项目都列在上面了，可相互对照修改。doxygen editor根据版本不同可修改项也不同，个人意见还是在文本编辑器中操作。

再次点击@即可生成文档了。