doxygen生成html文件,doxygen 的安装、配置、编译及使用(从源代码到文档)

doxygen 的安装、配置、编译及使用(从源代码到文档)

1. 什么是 doxygen

下面是 doxygen 主页上的一段说明文字

Source code documentation generator tool

Doxygen is a documentation system for C++,

C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors),

Fortran, VHDL, PHP, C#, and to some extent D.

简单地说,doxygen 能够自动分析源代码并从源代码中抽取相应的注释,整理成文档。

它的好处是源代码与文档同步,易于维护

下面以Fedora 10 和 doxygen 1.5.8 为例来说明其安装和使用

2. 安装

a. 下载源代码

b. 下载用户手册

这里面的内容很详细,从下载、编译、安装、使用都写得很清楚

c. 编译

这是linux下标准的安装方式

首先用tar命令 解压源代码,然而用cd命令进入解压后的文件夹,

运行./configure --help 查看配置

运行 ./configure --enable-langs --with-doxywizard --with-doxyapp进行配置

编译 make

安装 make install

3. 使用

doxygen

生成文档的基本方式是先生成一个配置文件,告诉doxygen如何去生成文档,然后让doxygen生成文档。由于doxygen的配置文件选项有很多,

因此我们通常是让doxygen先生成一个默认的配置文件,再修改其中的一些选项,生成自己的配置文件。

a. 生成默认配置文件

首先用 cd命令,进入 源代码所在的文件夹

然后运行 doxygen -g命令,生成 默认的配置文件

因为没有指定配置文件的文件名,因此生成的默认配置文件 自动命名为 Doxyfile

b. 修改配置选项

用任何一种文本编辑器,打开 Doxyfile 文件

下面是一些配置选项及说明

RECURSIVE = YES   这可以让doxygen从配置文件所在的文件夹开始,递归地搜索所有的子目录及源文件

SOURCE BROWSER = YES 这会在最后生成的文档中,把所有的源代码包含在其中

INLINE SOURCES = YES 这会把函数的实现部分的代码包含在每个函数的说明部分,可以方便地查看函数的实现方式,但会让整个文档显得有些凌乱,故不推荐使用

GENERATE TREEVIEW = ALL 这会在HTML文档中,添加一个侧边栏,并以树状结构显示包、类、接口等的关系

GENERATE_LATEX = NO 这个设置将导致doxygen不生成pdf文档,不太喜欢pdf文档,把它关了吧

c. 生成文档

运行 doxygen Doxyfile 命令,生成文档

d. 查看文档

在 html 文件夹下,找到index.html文件,用浏览器,打开它,就可以查看生成的文档了 ^_)^

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/528632.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

keras优化算法_目标检测算法 - CenterNet - 代码分析

代码出处吃水不忘打井人,分析github上的基于keras的实现:xuannianz/keras-CenterNet​github.com代码主体结构模型训练的主函数流程如下所示,该流程也是使用keras的较为标准的流程。其中代码篇幅较大的是数据准备的部分,通常的代码…

html checkbox 禁用,js禁用checkbox

两种禁用checkbox的方法:代码示例:-//W3C//DTD HTML 4.01 Transitional//EN” “http://www.w3.org/TR/html4/loose.dtd”>function x(){// document.all.cb1.disabled true;// 方法一document.getElementsByName(“cb1”)[0].disabled true;//方法二}JavaScri…

html5 拍照 清晰度,html5强大的功能(一)

html5强大的功能(一)发布时间:2020-03-26 16:03html5得出现被传的神乎其神的,做前端的总是要跟随着潮流发展,不过在跟风之前还是想要了解一下html5真正的魅力所在。html5创建的目的是以一种标准和直观的UI标记语言来把web设计和开发变得容易起…

徽柏工业机器人_新松机器人股票(中国机器人公司排名是怎样的?)

他们有:新时达、万丰科技、沃德福、徽柏等。5、深圳市汇川技术股份有限公司 。椅子孟安波扔过去&孤覃白曼走出去$安徽埃夫特--奇瑞工业机器人沈阳新松zhidao---新松机器人其实国产机器人主体未有一家达到规模,道4、宁波均胜电子回股份答有限公司 &am…

python初学者用什么开发环境搭建_2019-04-11 python入门学习——配置机器及搭建开发环境...

#  在windows操作系统中搭建python 3.x版本的开发环境,开发工具为 Anaconda 3.#1.1  下载及安装Anaconda 3Anaconda的特点:集成性高,包含很多常用的开发软件包,省去下载和安装软件包的时间。下载地址:https://www.…

html5 视频 showtime,利用function showTime显示不出时间是为什么?

js-01.htmlvar todaynew Date();var yeartoday.getYear();var monthtoday.getMonth();var hourtoday.getHours();var minutetoday.getMinutes();function showTime(){document.getElementById("content").innerHTML"现在为您报时:";document.ge…

c语言中创建一个整数数组_VBA中动态数组的创建及利用方法

大家好,后疫情时代一定会到来,各行各业,都将是一场战胜萧条的无声的战役。无论怎样,我们一定要坚信,疫情终将会过去,曙光一定会到来。后疫情时代将会是一个全新的世界,很多理念都将被打破&#…

用计算机求函数公式,计算机常用的函数公式有哪些?

01计算机常用的函数公式包括RANK函数、COUNTIF函数、IF函数、ABS函数、AND函数、AVERAGE函数、COLUMN 函数等。RANK函数是Excel计算序数的主要工具,它的语法为:RANK(number,ref,order),其中number为参与计算的数字或含…

js判断ipad还是安卓_JS判断客户端是否是iOS或者Android

每个客户端都带有自身的UA标识,通过JavaScript,可以获取客户端标识,我们可以获取浏览器的userAgent,用正则来判断手机是ios(苹果)还是Android(安卓)客户端。代码如下:var u navigator.userAgent;var isAndroid u.ind…

.net 移除html标签,.net去除html标签代码

.net去除html标签代码public string NoHTML(string Htmlstring){//删除脚本Htmlstring Regex.Replace(Htmlstring, "", "", RegexOptions.IgnoreCase);//删除HTMLHtmlstring Regex.Replace(Htmlstring, "", "$br$", RegexOptions.I…

golang 读取文件最后一行_python3从零学习-5.4.3、文件输入流fileinput

源代码: Lib/fileinput.py此模块实现了一个辅助类和一些函数用来快速编写访问标准输入或文件列表的循环。 如果你只想要读写一个文件请参阅 open().典型用法为:import fileinputfor line in fileinput.input(): process(line)这将遍历sys中列出的所有文件的行。argv[1:]如果…

云计算机具体应用场景,云计算的定义、类型及应用场景

云计算是20年来IT行业出现的最激动人心且最具颠覆性的技术,甚至比大型主机向客户端/服务器架构的迁移还更具颠覆性。无论是IT服务的交付方式,还是企业消费这些IT服务的方式,都因云计算而改变。用户也正在快速应对新架构带来的变革&#xff0c…

dataframe for循环 筛选_Python循环12种超强写法,又快又省内存

0 前言说到处理循环,我们习惯使用for, while等,比如依次打印每个列表中的字符:在打印内容字节数较小时,全部载入内存后,再打印,没有问题。可是,如果现在有成千上百万条车辆行驶轨迹,…

html5文字飞入插件,jquery使用CSS3实现文字动画效果插件Textillate.js

jquery使用CSS3实现文字动画效果插件Textillate.jsTextillate是一款基于CSS3动画效果的 JavaScript 库,您可非常轻轻松地把这些动画效果应该于网页中的任何文字。使用方法引入核心文件构建html标签My Title写入JS,初始化$(function () {$(.tlt).textilla…

工业机器人导轨 百度文库_工业机器人或许开创一个全新的PLC时代

自机器人诞生之日起人们就不断地尝试着说明到底什么是机器人。但随着机器人技术的飞速发展和信息时代的到来,机器人所涵盖的内容越来越丰富,机器人的定义也不断充实和创新。机器人技术作为20世纪人类最伟大的发明之一,自20世纪60年代初问世以…

计算机和互联网基础知识作业,计算机作业1基础知识含答案.doc

计算机作业1基础知识含答案.doc跳到主要内容网络课程学院主页 E-Learning 实验室 联系我们 窗体顶端窗体底端页面路径 首页/ 我的课程/ 计算机应用基础2299/ 主题 2/ 第一次作业 计算机基础知识开始时间 2015 年 10 月 1 日 星期四 1301完成于 2015 年 10 月 1 日 星期四 1435耗…

天津计算机的专科学校,天津市电子计算机职业中等专业学校

天津市电子计算机职业中等专业学校创建于980年,是首批国家级重点职业中专,是国家级中等职业教育改革发展示范学校建设单位天津市职业教育先进单位。办学30多年来,学校本着“以人为本传承发展”的原则,培养面向现代化的复合型人才,取得了很好的办学效益和社会效益,学校实训设备先…

内存超频trfc_内存超频教学

一、前言先说说内存超频的作用,在很多应用里,内存超频能带来显著提升,就比如PUBG、CSGO等FPS游戏,超频后的帧数表现和超频前的帧数表现相差很多。也有很多人觉得超频很麻烦,觉得超频会损害硬件的使用寿命,其…

前端html预览,HTML5 上传前预览

下面是前端之家 f2er.com 通过网络收集整理的代码片段。前端之家小编现在分享给大家,也给大家做个参考。HTML5上传图片预览请选择图片文件:JPG/GIF$("#file0").change(function(){var objUrl getObjectURL(this.files[0]) ;console.log("…

银联分账与银联代付_第三方分账系统到底有哪些作用?

随着监管越来越严,业务越来越复杂,所有平台电商企业都需要通过第三方分账系统解决支付清算及二清等问题。作为第三方分账系统行业从业者,整理了部分关于系统的相关问题及解答,希望对大家有所帮助。问题一:第三方分账系…