当前位置： 首页 > news >正文

Linux Doxygen快速生成文档

news 2026/5/16 6:19:13

此前写过一篇编写Doxygen格式的注释以用于生成文档,点击以查阅, Doxygen常用语法与字段记录,但是当时用的windows桌面版的doxygen,最近使用ubuntu编写代码想直接使用doxygen生成,故写下此博客

Doxygen

Doxygen是一个用于生成软件文档的工具，它可以从代码中提取注释并根据这些注释自动生成文档。这些注释可以是特殊格式的注释，比如C、C++、Java等语言中的特定格式，也可以是Markdown格式的注释。
以下是一些Doxygen的主要特点和用途：

  1. 自动生成文档：Doxygen可以从源代码中提取注释，并生成各种格式的文档，包括HTML、PDF、LaTeX等。这样可以轻松地为你的项目生成专业的文档。
  2. 支持多种编程语言：Doxygen支持多种编程语言，包括C、C++、Java、Python等主流编程语言。你可以在不同的项目中使用Doxygen来生成文档。
  3. 丰富的文档格式：Doxygen支持多种文档格式，包括类图、调用图、文件列表等。它还支持跳转到定义、引用和继承等功能，使生成的文档更加详细和易于导航。
  4. 可定制性强：Doxygen提供了丰富的配置选项，可以根据你的需求定制文档的样式和内容。你可以通过配置文件或命令行选项来控制生成的文档。
  5. 支持多种输出格式：Doxygen可以生成多种格式的输出文档，包括HTML、PDF、LaTeX等。这使得你可以选择最适合你项目的文档格式。我们在接下来的课程当中，主要使用它来了解第三方库的使用。

Doxygen安装

在 Ubuntu 系统中，执行下面命令安装 doxygen 和 graphviz 软件包。

sudo apt install graphviz    # 用于生成代码关系图
sudo apt install doxygen

使用示例

进入工程目录，执行下面命令生成配置文件

doxygen -g Doxygen.config

修改配置文件vim Doxygen.config,找到如下字段修改为YES

对于美观有要求可以自行查阅相关资料,修改一些字段

EXTRACT_ALL            = YES
HAVE_DOT               = YES
UML_LOOK               = YES
RECURSIVE              = YES

根据代码生成文档

doxygen Doxygen.config

生成效果展示

image-20240616161835187

image-20240616161851720

image-20240616161935095

相关文章：

Linux Doxygen快速生成文档

此前写过一篇编写Doxygen格式的注释以用于生成文档,点击以查阅, Doxygen常用语法与字段记录,但是当时用的windows桌面版的doxygen,最近使用ubuntu编写代码想直接使用doxygen生成,故写下此博客 Doxygen Doxygen是一个用于生成软件文档的工具，它可以从代码中提取注释…...

编程日记 2024/6/29 23:24:40

MobPush REST API的推送 API之批量推送

调用验证 详情参见 REST API 概述的 鉴权方式 说明。 频率控制 详情参见推送限制策略的 接口限制 说明。 调用地址 POST http://api.push.mob.com/v3/push/createMulti 推送对象 以 JSON 格式表达，表示一条推送相关的所有信息 字段类型必须说明pushWorkobje…...

编程日记 2024/6/29 23:23:37

Arthas快速入门

简介 Arthas 是一款线上监控诊断产品，通过全局视角实时查看应用 load、内存、gc、线程的状态信息，并能在不修改应用代码的情况下，对业务问题进行诊断，包括查看方法调用的出入参、异常，监测方法执行耗时，类…...

编程日记 2024/6/29 23:20:34

python系列30：各种爬虫技术总结

1. 使用requests获取网页内容 以巴鲁夫产品为例，可以用get请求获取内容： https://www.balluff.com.cn/zh-cn/products/BES02YF 对应的网页为： 使用简单方法进行解析即可 import requests r BES02YF res requests.get("https://www.…...

编程日记 2024/6/29 23:19:32

PHP和phpSpider：如何应对反爬虫机制的封锁？

php和phpspider：如何应对反爬虫机制的封锁？ 引言： 随着互联网的快速发展，对于大数据的需求也越来越大。爬虫作为一种抓取数据的工具，可以自动化地从网页中提取所需的信息。然而，由于爬虫的存在&#xff0c…...

编程日记 2024/6/29 23:17:30

学生宿舍管理系统

摘 要 随着高校规模的不断扩大和学生人数的增加，学生宿舍管理成为高校日常管理工作中的重要组成部分。传统的学生宿舍管理方式往往依赖于纸质记录和人工管理，这种方式不仅效率低下，而且容易出错，无法满足现代高校管理的需求。因此…...

编程日记 2024/6/29 23:16:30

一分钟彻底掌握Java迭代器Iterator

Iterator Iterator 是 Java 的 java.util 包中的一个接口 iterator() 是 Java 集合框架中的一个方法，它返回一个 Iterator 对象，该对象可以用来遍历集合中的元素。 Iterator确实是一个接口，你不能直接实例化一个接口。但是，你可以…...

编程日记 2024/6/29 23:11:24

第三十七篇——麦克斯韦的妖：为什么要保持系统的开放性？

目录 一、背景介绍二、思路&方案三、过程1.思维导图2.文章中经典的句子理解3.学习之后对于投资市场的理解4.通过这篇文章结合我知道的东西我能想到什么？ 四、总结五、升华 一、背景介绍 如果没有详细的学习这篇文章，我觉得我就是被麦克斯韦妖摆弄的…...

编程日记 2024/6/29 23:08:21

青岛网站建设一般多少钱

青岛网站建设的价格一般会根据网站的规模、功能、设计风格等因素来定，价格会存在着一定的差异。一般来说，一个简单的网站建设可能在数千元到一万元之间，而一个复杂的大型网站建设可能会需要数万元到数十万元不等。所以在选择网站建设服务时&a…...

编程日记 2024/6/29 23:07:20

Linux 进程状态：TASK_INTERRUPTIBLE 和 TASK_UNINTERRUPTIBLE

文章目录 1. 前言2. TASK_INTERRUPTIBLE 和 TASK_UNINTERRUPTIBLE2.1 语义2.2 实现2.2.1 TASK_INTERRUPTIBLE 实现2.2.1.1 等待的条件成立时 唤醒2.2.1.2 信号 唤醒2.2.1.3 中断 唤醒2.2.1.3.1 内核态的处理过程2.2.1.3.2 用户态的处理过程 2.2.2 TASK_UNINTERRUPTIBLE 实现 2.…...

编程日记 2024/6/29 23:05:18

vue3使用vant4的列表vant-list点击进入详情自动滚动到对应位置，踩坑日记（一天半的踩坑经历）

1.路由添加keepAlive <!-- Vue3缓存组件&#xff0c;写法和Vue2不一样--><router-view v-slot"{ Component }"><keep-alive><component :is"Component" v-if"$route.meta.keepAlive"/></keep-alive><component…...

编程日记 2024/6/29 23:04:17

Linux的fwrite函数

函数原型: 向文件fp中写入writeBuff里面的内容 int fwrite(void*buffer&#xff0c;intsize&#xff0c;intcount&#xff0c;FILE*fp) /* * description : 对已打开的流进行写入数据块 * param ‐ ptr &#xff1a;指向 数据块的指针 * param ‐ size &#xff1a;指定…...

编程日记 2024/6/29 23:02:14

python udsoncan 详解

python udsoncan 详解 udsoncan 是一个Python库&#xff0c;用于实现汽车统一诊断服务&#xff08;Unified Diagnostic Services&#xff0c;UDS&#xff09;协议。UDS是一种用于汽车诊断的标准化通信协议&#xff0c;它定义了一系列的服务和流程&#xff0c;用于ECU&#xff…...

编程日记 2024/6/29 23:00:12

基于自组织长短期记忆神经网络的时间序列预测（MATLAB）

LSTM是为了解决RNN 的梯度消失问题而诞生的特殊循环神经网络。该网络开发了一种异于普通神经元的节点结构&#xff0c;引入了3 个控制门的概念。该节点称为LSTM 单元。LSTM 神经网络避免了梯度消失的情况&#xff0c;能够记忆更长久的历史信息&#xff0c;更能有效地拟合长期时…...

编程日记 2024/6/29 22:57:08

240629_昇思学习打卡-Day11-Vision Transformer中的self-Attention

240629_昇思学习打卡-Day11-Transformer中的self-Attention 根据昇思课程顺序来看呢&#xff0c;今儿应该看Vision Transformer图像分类这里了&#xff0c;但是大概看了一下官方api&#xff0c;发现我还是太笨了&#xff0c;看不太明白。正巧昨天学SSD的时候不是参考了太阳花的…...

编程日记 2024/6/29 22:56:07

代码随想录-Day43

52. 携带研究材料&#xff08;第七期模拟笔试&#xff09; 小明是一位科学家&#xff0c;他需要参加一场重要的国际科学大会&#xff0c;以展示自己的最新研究成果。他需要带一些研究材料&#xff0c;但是他的行李箱空间有限。这些研究材料包括实验设备、文献资料和实验样本等…...

编程日记 2024/6/29 22:54:03

C++——探索智能指针的设计原理

前言: RAII是资源获得即初始化&#xff0c; 是一种利用对象生命周期来控制程序资源地手段。 智能指针是在对象构造时获取资源&#xff0c; 并且在对象的声明周期内控制资源&#xff0c; 最后在对象析构的时候释放资源。注意&#xff0c; 本篇文章参考——C 智能指针 - 全部用法…...

编程日记 2024/6/29 22:52:02

办公效率新高度：利用办公软件实现文件夹编号批量复制与移动，轻松管理文件

在数字化时代&#xff0c;我们的工作和生活都围绕着海量的数据和文件展开。然而&#xff0c;随着数据量的不断增加&#xff0c;如何高效地管理这些数字资产成为了摆在我们面前的一大难题。今天&#xff0c;我要向您介绍一种革命性的方法——利用办公软件实现文件夹编号批量复制…...

编程日记 2024/6/29 22:51:01

Windows kubectl终端日志聚合(wsl+ubuntu+cmder+kubetail)

Windows kubectl终端日志聚合 一、kubectl终端日志聚合二、windows安装ubuntu子系统1. 启用wsl支持2. 安装所选的 Linux 分发版 三、ubuntu安装kubetail四、配置cmder五、使用 一、kubectl终端日志聚合 k8s在实际部署时&#xff0c;一般都会采用多pod方式&#xff0c;这种情况下…...

编程日记 2024/6/29 22:49:59

【MySQL】数据库——事务

一.事务概念 事务是一种机制、一个操作序列&#xff0c;包含了一组数据库操作命令&#xff0c;并且把所有的命令作为一个整体一起向系统提交或撤销操作请求&#xff0c;即这一组数据库命令要么都执行&#xff0c;要么都不执行事务是一个不可分割的工作逻辑单元&#xff0c;在数…...

编程日记 2024/6/29 22:48:57

开源AI本地化框架py-gpt：微内核插件化架构与RAG应用实战

1. 项目概述&#xff1a;一个本地化、可扩展的AI应用框架最近在折腾AI应用本地化部署的朋友&#xff0c;可能都绕不开一个核心矛盾&#xff1a;既想享受大语言模型&#xff08;LLM&#xff09;强大的对话和推理能力&#xff0c;又对数据隐私、网络依赖和持续付费心存顾虑。市面…...

编程新知 2026/5/16 6:18:36

从ASCII到机器码：深入解析HEX文件的结构与校验机制

1. HEX文件的前世今生&#xff1a;从ASCII到机器码的桥梁 第一次接触HEX文件时&#xff0c;我也被那一串串看似毫无规律的十六进制字符搞得一头雾水。直到后来在嵌入式开发中频繁使用HEX文件进行固件升级&#xff0c;才真正理解了这个"翻译官"的重要性。HEX文件本质上…...

编程新知 2026/5/16 5:42:26

DevUI布局系统完全指南：响应式设计的终极解决方案

DevUI布局系统完全指南&#xff1a;响应式设计的终极解决方案 【免费下载链接】ng-devui Angular UI Component Library based on DevUI Design 项目地址: https://gitcode.com/DevCloudFE/ng-devui DevUI布局系统是Angular UI组件库中的核心功能&#xff0c;为开发者提…...

编程新知 2026/5/16 4:40:03

Python-ADB协议实现原理：深入理解ADB和Fastboot通信机制

Python-ADB协议实现原理&#xff1a;深入理解ADB和Fastboot通信机制 【免费下载链接】python-adb Python ADB Fastboot implementation 项目地址: https://gitcode.com/gh_mirrors/py/python-adb Python-ADB是一个强大的开源项目&#xff0c;提供了ADB&#xff08;Andr…...

编程新知 2026/5/16 4:35:45

Go语言建造者模式：复杂对象构建

Go语言建造者模式&#xff1a;复杂对象构建 1. 建造者实现 type User struct {Name stringAge intEmail stringPhone stringAddress string }type UserBuilder struct {user *User }func NewUserBuilder() *UserBuilder {return &UserBuilder{user: &User{}…...

编程新知 2026/5/16 4:17:10

Vivado XADC IP核 配置与接口实战解析

1. XADC IP核基础入门 XADC&#xff08;Xilinx Analog-to-Digital Converter&#xff09;是Xilinx FPGA芯片内置的高精度模拟数字转换模块&#xff0c;它能实时监测芯片内部的电压、温度以及外部模拟信号。在Vivado开发环境中&#xff0c;我们可以通过XADC Wizard IP核快速配置…...

编程新知 2026/5/16 3:49:22

突然想写一些东西

---title: blogdate: 2026-05-15 02:18:57tags: ["chitchat"]about: 突然想写一些东西---马上毕业了&#xff0c;在写致谢的时候发现好像想写的东西挺多的&#xff0c;但是不知道怎么写出来了&#xff0c;可能是因为很久没写东西了&#xff1f;也可能是AI用多了自己深…...

编程新知 2026/5/16 3:17:20

嵌入式开发中的模拟信号处理：ADC、DAC与PWM核心原理与CircuitPython实战

1. 项目概述&#xff1a;从数字世界到物理世界的桥梁在嵌入式开发的世界里&#xff0c;我们写的代码最终是要和物理世界打交道的。物理世界是连续的、模拟的——光线强弱、温度高低、声音大小&#xff0c;这些都不是简单的“开”或“关”&#xff0c;而是平滑变化的连续量。而我…...

编程新知 2026/5/16 2:26:50

基于大语言模型的智能终端助手：LetMeDoIt的设计、部署与实战

1. 项目概述&#xff1a;一个能听懂人话的AI终端伴侣如果你和我一样&#xff0c;每天有大量时间泡在终端里&#xff0c;那么“如何让命令行更智能、更高效”一定是个永恒的课题。传统的CLI工具链虽然强大&#xff0c;但学习曲线陡峭&#xff0c;命令参数繁多&#xff0c;上下文…...

编程新知 2026/5/16 2:09:29

快速上手Redis

一、认识Redis Redis 是一个内存数据库&#xff0c;常用于缓存和高性能数据存储。特点&#xff1a; 数据存储在内存&#xff0c;读写速度快&#xff08;毫秒级甚至微秒级&#xff09;支持多种数据结构&#xff1a;String、Hash、List、Set、Sorted Set&#xff08;ZSet&#…...

编程新知 2026/5/16 1:46:28