doxygen安装与使用

环境：

Ubuntu 18.04

安装：

sudo apt-get install doxygen

如果要使用图形工具，则

sudo apt-get install doxywizard
sudo apt-get install graphviz

如果doxywizard使用时报错，cannot find dot，就是没有安装graphviz。

如果不想安装graphviz，可以在doxywizard的“Wizard”->“Topics”->"Diagrams"中选择“No diagrams”或其他，反正不要选择“Use dot tool from the Graphviz package”就可以。

使用：

新建一个test目录，在目录下新建文件QTstyle_Test.h，如下

//!  A test class.
/*!A more elaborate class description.
*/class QTstyle_Test
{public://! An enum./*! More detailed enum description. */enum TEnum { TVal1, /*!< Enum value TVal1. */  TVal2, /*!< Enum value TVal2. */  TVal3  /*!< Enum value TVal3. */  } //! Enum pointer./*! Details. */*enumPtr, //! Enum variable./*! Details. */enumVar;  //! A constructor./*!A more elaborate description of the constructor.*/QTstyle_Test();//! A destructor./*!A more elaborate description of the destructor.*/~QTstyle_Test();//! A normal member taking two arguments and returning an integer value./*!\param a an integer argument.\param s a constant character pointer.\return The test results\sa QTstyle_Test(), ~QTstyle_Test(), testMeToo() and publicVar()*/int testMe(int a,const char *s);//! A pure virtual member./*!\brief just a member function.\sa testMe()\param c1 the first argument.\param[out] c2 the second argument.*/virtual void testMeToo(char c1,char c2) = 0;//! A public variable./*!Details.*/int publicVar;//! A function variable./*!Details.*/int (*handler)(int a,int b);
};

在test目录中打开命令行，生成默认的doxygen配置文件（默认文件名为Doxyfile）：

doxygen -g

生成默认的html和latex文档：

doxygen Doxyfile

用浏览器打开test/html文件夹下的index.html文件可以看到生成的文档。

参考：

http://www.doxygen.nl/manual/starting.html

doxygen安装与使用相关推荐

ubuntu doxygen 安装与常用配置
ubuntu doxygen 安装与常用配置 ubuntu 安装与使用doxygen 安装doxygen 安装Graphviz 生成doxygen配置文件常用配置根据配置生成doxygen文档 u ...
Doxygen安装和使用
1.简介 Doxygen是一个文本生成工具,用于为源码生成说明文档. 我们可以在代码中按照 Doxygen 要求的语法编写代码注释,然后使用 Doxygen 将程序中的注释提取出来生成一个文档. 我们 ...
Doxygen 安装使用
安装 # graphviz 用于生成图, doxygen-guigraphviz 是 doxygen 的 GUI sudo apt-get install graphviz doxygen doxyg ...
doxygen安装(doxygen的编译依靠cmake)
step1.下载源码 $ git clone https://github.com/doxygen/doxygen.git step2.编译 $ cd doxygen $ mkdir build $ ...
Doxygen从零学起———安装和配置
Doxygen可以为多种语言生成说明文档(从程序的源代码中提取其中按照约定格式写的注释中提取信息) 例如C++, Objective-C, C#, C, PHP, Python, IDL (Corba ...
源代码文档生成 Doxygen介绍(转载)
源代码文档生成 Doxygen介绍(转载) 收藏 Doxygen介绍一.Doxygen介绍在项目开发过程中最重要的是如何和团队中其它成员沟通,如何在项目完成后减低维护成本,随着公司的人员流动,怎样 ...
Doxygen自动文档生成工具在Eclipse中的集成及使用举例
你有为软件编写说明文档的苦恼吗?当别人甩给你一个庞大的系统,让你根据里面的代码注释理解后写出一份完整的开发文档,你会怎么办?一个个的看代码然后耗时N天来写吗?这既是一份苦差事也极其耗时,有没有更好的 ...
代码文档生成工具-Doxygen生成CHM和RTF图文教程
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,可以从一套归档源文件开始,生成chm格式的文档.本文主要讲解如何在winddows下安装doxygen. 1.下载doxyge ...
doxygen html chm,使用Doxygen生成全中文的chm帮助文档
2010年曾经使用Doxygen生成全中文的chm文档.由于Doxygen生成的chm目录文件(index.hhc)本身是使用UTF-8编码的,而古老的chm编译器(HTML Help Worksho ...

doxygen安装与使用

环境：

安装：

使用：

参考：

doxygen安装与使用相关推荐

最新文章

热门文章