搭建Doxygen环境从代码中提取文档——Doxygen安装

飞箭前面的蜗牛 飞箭前面的蜗牛 博客等级 墨衍会员 · AI 创作全网分发 墨衍智能分发 本文由作者通过墨衍一键同步至各平台 1分发平台 400+累计阅读 470平均单平台 已同步平台 优快云 微信公众号 微博 知乎 掘金 百家号 博客园 抖音 小红书 你的文章也可以这样分发 墨衍会员 ¥399起/年，写一次发全网 我也要 码龄12年
关注
原创 2022-05-26 20:49:29 470 阅读 AI 写同款· GEO 优化 ›
Doxygen 使用指南 Doxygen是一个文档生成工具，可以从源代码中的注释生成高质量的文档，支持多种编程语言。 阅读详情

搭建Doxygen环境从代码中提取文档——Doxygen安装

文章目录

目标：

  • 使用Doxygen提取C源码中的文档
  • 搭建LaTeX环境，生成pdf文件
  • 使用plantUML插入UML图

ubuntu 20.04 安装 Doxygen

apt 命令安装

sudo apt install doxygen

安装提示

# 将建议安装的软件也安装一下
sudo apt install doxygen-latex doxygen-doc doxygen-gui graphviz xapian-tools

使用Doxygen官网提供的bin文件安装

官网提供的安装指导链接
bin文件下载

下载下面这个文件后，解压

tar -xf doxygen-1.9.4.linux.bin.tar.gz

下载链接
修改Makefile文件，添加下面几行代码

	$(INSTTOOL) -m 755 bin/doxyindexer    $(INSTALL)/bin
	$(INSTTOOL) -m 755 bin/doxywizard    $(INSTALL)/bin
	$(INSTTOOL) -m 755 bin/doxysearch.cgi    $(INSTALL)/bin

在这里插入图片描述
这个主要是为了安装doxywizard这个图形化的配置工具

官网入门指南

标签
#ubuntu #linux #运维
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
Doxygen的安装与使用及注释语法 文章目录1. Doxygen的安装使用1.1 选择配置源码目录和目标文件目录1.2 Mode配置1.3 选择生成 chm 帮助文件1.4 调用关系图配置1.5 工程文件编码格式配置1.6 设置提取的范围1.7 Input配置1.8 chm文件设置1.9 生成的调用关系图配置1.10 生成 chm帮助文件2. Doxygen注释语法2.1 简单注释2.2 文件注释2.3 类定义注释2.4 常量/变量的注释2.5 函数注释   Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。提供 阅读详情

相关推荐

C语言 - Doxygen代码注释规范

什么是Doxygen ； 他有什么作用？ Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。 Doxygen 是一个程序的...

Matlab - Data_Reconstruction 6072

API文档生成工具——Doxygen

1 简介   为代码写注释一直是大多数程序员有些困扰的事情。更头痛的是写文档，以及维护文档的问题，而doxygen就能把遵守某种格式的注释自动转化为对应的文档。   Doxygen是基于GPL的开源项目，是一个非常优秀的文档系统，当前支持在大多数unix（包括linux），windows家族，Mac系统上运行，完全支持C++, C, Java, IDL（Corba和Microsoft 家族...

liao20081228的博客 7442

Doxygen——根据代码注释生成文档的工具

文章目录1 简介2 安装3 使用3.1 注释代码3.2 使用doxywizard生成文档4 用例4.1 OpenCV4.2 Apollo5 参考 1 简介 Doxygen是一个可以根据代码注释生成文档的工具，支持HTML、CHM、LaTex等格式。主要支持C语言、Python语言，还支持C++、Java、C#等语言。 通常我们在写程序时，或多或少都会写上注释，但是对于其它人而言，要直接探索程序里的注释会比较麻烦。大部分有用的注释都是属于对函数、类型等的说明。所以，如果能依据程序本身的结构，将注释经过处理重新

W_Tortoise的博客 8456

Doxygen (1): 安装及设置

Doxygen 安装 & 配置

qq_37896521的博客 4779

Ubuntu下的Doxygen+VScode实现C/C++接口文档自动生成

Doxygen 是一个由 C++ 编写的、开源的、跨平台的文档生成系统。最初主要用于生成 C++ 库的 API 文档，但目前又添加了对 C、C#、Java、Python、Fortran、PHP 等语言的支持。其从源代码中提取注释，并生成多种输出格式，如HTML、PDF、LaTeX、RTF等，以帮助开发者创建易于阅读和理解的代码文档。Doxygen 简化了另行编写文档带来的重复性劳动，将代码和文档的工作合二为一。经过 10 年的迭代，Doxygen 成为了 C/C++ 项目首选的文档生成工具。

youlinhuanyan的博客 1648

cmake使用doxygen生成document

1. 安装doxygen sudo apt install doxygen sudo apt install graphviz（生成dot需要） 2. 创建Doxyfile.in文件 注：可使用doxygen -g命令生成默认的Doxyfile，cmake则是通过Doxyfile.in来生成Doxyfile # 项目名称，将作为于所生成的程序文档首页标题 PROJECT_NAME ...

xiaoou的博客 5624

doxygen安装与使用

Output和Diagrams也没什么好动的。

实践出真理，接毕设/课设项目开发指导 772

第75期 Doxygen是干嘛的，Windows版本，如何安装，学习

规范的注释是一个良好的编程习惯。Doxygen可以直接将注释提取为程序文档，便于开发人员使用本文主要介绍了Doxygen的使用方法，更多细节请阅读官方文档一、Doxygen是什么？doxygen是一个文档生成工具，用于为源码生成文档，我们可以在代码中按照doxygen要求的语法编写代码注释，然后使用doxygen将程序中的注释提取出来生成一个文档一般都把注释写在代码中，所以使用doxygen生成的文档也可以非常方便地更新。doxygen还会在文档中引用源码文件，故我们也可以在文档中方便地查看源码。

qq_43389859的博客 1314

【Doxygen】Doxygen使用教程（个人总结）

【Doxygen】Doxygen使用教程（个人总结） 简介Doxygen 引言．什么是Doxygen? Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探索程序里的批注，与打捞铁达尼号同样的辛苦。大部分有用的批注都是属于针对函式，类别等等的说明。所以，如果能依据程序本身的结构，将批注经过处理重新整理成为一个纯粹的参考手册，对于后面利用您的程序代码的人而言将会减少许多的负担。不过，反过来说，整理文件的工作对于您

qq_43331089的博客 5万+

Doxygen—程序文档生成工具

Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。 使用步骤 1、第一次使用需要安装doxygen的程序

Peter-H 1万+

doxygen安装包

Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。可以生成html、chm、pdf、rtf注释文档。很好用的哦~

在VSCode中使用Doxygen插件注释代码 + Doxygen GUI生成API文档

Doxygen是用来根据代码中注释生成标准API文档的一种方式。

人非生而知之者 3292

什么是论文的创新点？公式化描述算是创新点吗？

写科研论文时，挑战之一就是如何让你的工作“脱颖而出”，也就是要有创新性。不管实验多么精确、推导多么复杂，若没有真正的创新，论文很可能会被拒。关于如何创新问题上，我最近在看刘雪峰老师的《科技论文写作指南》，看到了很多关于写作的新论述，在这里和大家进行分享。

加百力 的技术博客 1928

Windows环境下代码文档生成工具Doxygen使用详细教程

Windows环境下代码文档生成工具Doxygen使用详细教程

世界那么大，我想去看看～【随心更新，看世界去了😄】 5894

Autodesk全家桶怎么选？AutoCAD、Revit、Fusion 360等7款软件超全对比指南

本文深入对比了Autodesk旗下七款核心软件（AutoCAD、Revit、Inventor、Fusion 360、Maya、3ds Max、Forge）的核心定位与适用场景。针对建筑、制造、创意设计等不同专业需求，提供精准的选型指南，帮助用户根据自身工作流（如二维绘图、BIM协同、产品开发、影视动画）选择最匹配的工具，避免资源浪费并提升效率。

stone的博客 434

Godot4 TileMap分层绘制全攻略：解决角色、树木遮挡混乱，打造正确视觉层级

本文详细介绍了Godot4 TileMap分层绘制技术，通过图层管理和Y-Sort功能解决2D游戏中角色与物体的遮挡问题。从基础图层设置到高级优化策略，帮助开发者打造符合自然视觉规律的场景层次，提升游戏沉浸感。特别针对TileMap和TileSet的使用提供了实用技巧和代码示例。

weixin_28717411的博客 514

代码文档生成工具Doxygen教程及实例

程序员的很多文档，特别是有代码的文档，绝大部分都是由一款文档生成工具【Doxygen】生成。 什么是Doxygen? Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探索程序里的批注，与打捞铁达尼号同样的辛苦。 大部分有用的批注都是属于针对函式，类别等等的说明。所以，如果能依据程序本身的结构，将批注经过处理重新整理成为一个纯粹的参考手册，对于后面利用你的程序代码的人而言将会减少许多的负担。不过，反过来说，整.

qq_41854911的博客 1万+

PCIe中ACS知识小记

虚拟机内部的访问数据显而易见是带的GPA地址。而目前几乎所有的PCIe 设备都带ACS control，所以它们可以单独assign给不同的VM，但是随之而来的就是即使两个GPU同时assign给同一个VM，由于ACS的存在，他们之间也不会有真正的物理层面的P2P访问。每一个TLP都自带一个address（寻址类TLP），同时每一个endpoint，PCIe switch都自带一段BIOS配置的地址空间范围，一旦这个TLP的address落入某个设备的地址范围，那么这个TLP就属于这个设备并消费。

Summer的博客 5079

使用Doxygen实现代码自文档化

Doxygen是一个程序的文档产生工具，可以将程序中的注释转换成说明文档，后者API参考手册要遵守一定的注释规范，才能被Doxygen识别和转化在每个代码项中都可以有两类描述：brief描述 和 detailed描述；两种任选其一若需要通过Doxygen生成漂亮的文档，一般有如下几个地方需要使用Doxygen支持的风格进行注释头文件(.h 和 .hpp)：主要用于声明版权，描述本文件实现的功能，以及文件版本信息等。

宁静致远的博客 1402

别再被坑了！手把手教你从官网下载免费正版Notepad++（附最新网盘链接）

本文详细指导如何从Notepad++官网安全下载正版软件，避免山寨版本带来的安全风险。通过识别官网特征、推荐官方下载渠道、揭露山寨网站骗局及验证正版功能，帮助用户高效获取纯净的Notepad++代码编辑器，并分享实用插件和配置优化技巧。

weixin_42527654的博客 570

计量经济学（因果关系探究-空间双重差分模型: 破解空间溢出效应的因果分析工具)

本文介绍了传统双重差分（DID）模型及其局限性，重点阐述了空间DID模型的必要性。传统DID通过组间差分分离干预效应，但无法处理空间溢出效应。空间DID模型引入空间计量方法，包括三种类型：空间自回归模型（SDID-SAR）捕捉因变量溢出，空间误差模型（SDID-SEM）处理残差相关性，空间杜宾模型（SDID-SDM）同时考虑因变量和自变量的空间滞后。模型选择需结合空间相关性检验，适用于环境政策、房地产限购等存在空间交互效应的研究场景。

YBAdvanceFu的博客 2033

Doxygen从零学起———安装和配置

Doxygen可以为多种语言生成说明文档（从程序的源代码中提取其中按照约定格式写的注释中提取信息） 例如C++, Objective-C, C#, C, PHP, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, D ,从这期开始，我将系统地介绍Doxygen的使用，包括以下内容： Dox

生如蚁，美如神 4211

IEC104协议学习专栏内容规划

IEC104协议的编程学习

sixtome 1110

Could NOT find Doxygen (missing: DOXYGEN_EXECUTABLE)

Doxygen是从带注释的C++源代码生成文档的事实上的标准工具，但它也支持其他流行的编程语言，例如C、Objective-C、C#、PHP、Java、Python、IDL（Corba、Microsoft和UNO/OpenOffice风格）)、Fortran，在某种程度上也支持D.Doxygen也支持硬件描述语言VHDL。可以配置doxygen以从未记录的源文件中提取代码结构。Doxygen还可以通过包括依赖图、继承图和协作图的方式将各种元素之间的关系可视化，这些都是自动生成的。...

zhangrelay的专栏 9680

计算机视觉（角点检测）- 1 - Harris角点检测

计算机视觉（角点检测）-1.1 Harris角点检测学习前言 学习前言   今天更新一下计算机视觉的东西吧，哈哈哈o(￣︶￣)o   关于角点检测呢，就是检测图像中角点的算法，常见的有四种常见的算法：Moravec角点检测算法、 Harris角点检测算法、Shi-Tomasi 算法、FAST角点检测算法，不过常用的就两种吧——Harris角点检测算法、Shi-Tomasi 算法（反正我基本上就只用到这两种，先着重介绍前面两种，后面再花世界介绍吧）(～￣▽￣)～ ...

qq_40374812的博客 1万+

IMSL CNL 7.0.0 (x86-64)Crack

IMSL CNL 7.0.0 (x86-64)Crack intel的算法库破解文件，这是C++版本的破解文件

Doxygen基本使用教程

本文介绍了Doxygen文档生成工具的使用方法，包括安装配置和注释语法。

Noxryn的博客 2770

LinePhone3.2.7(android端最新版本) sip客户端

SIP客户端For android：LinePhone3.2.7(最新版本)，官网地址：http://www.linphone.org/
上一篇： GoCD使用日记（1）
下一篇： RISC-V MCU开发笔记--基于HPM6750
点赞 0
评论 0
书签 书签 0
飞箭前面的蜗牛
飞箭前面的蜗牛
博客等级 码龄12年 1粉丝 7原创
+ 关注
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值