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

Linux Doxygen快速生成文档

news 文章来源：https://blog.csdn.net/weixin_50448879/article/details/140066297 2024/12/29 4:08:34

此前写过一篇编写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

python代码缩进规范（2空格或4空格）

C、C、Java、C#、Rust、Go、JavaScript 等常见语言都是用"{“和”}"来标记一个块作用域的开始和结束&#xff0c;而Python 程序则是用缩进来表示块作用域的开始和结束&#xff1a; 作用域是编程语言里的一个重要的概念&#xff0c;特别是块作用域&#xff0c;编程语言…...

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

前后端分离的后台管理系统开发模板（带你从零开发一套自己的若依框架）上

前言&#xff1a; 目前&#xff0c;前后端分离开发已经成为当前web开发的主流。目前最流行的技术选型是前端vue3后端的spring boot3&#xff0c;本次。就基于这两个市面上主流的框架来开发出一套基本的后台管理系统的模板&#xff0c;以便于我们今后的开发。 前端使用vue3ele…...

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

【C++ | 委托构造函数】委托构造函数 详解 及 例子源码

&#x1f601;博客主页&#x1f601;&#xff1a;&#x1f680;https://blog.csdn.net/wkd_007&#x1f680; &#x1f911;博客内容&#x1f911;&#xff1a;&#x1f36d;嵌入式开发、Linux、C语言、C、数据结构、音视频&#x1f36d; &#x1f923;本文内容&#x1f923;&a…...

编程日记 2024/6/29 22:45:53

iCloud邮件全攻略：设置与使用终极指南

标题&#xff1a;iCloud邮件全攻略&#xff1a;设置与使用终极指南 摘要 iCloud邮件是Apple提供的一项邮件服务&#xff0c;允许用户在所有Apple设备上访问自己的邮件。本文将详细介绍如何在各种设备和邮件客户端上设置和使用iCloud邮件账户&#xff0c;确保用户能够充分利用…...

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

【计算机毕业设计】基于微信小程序的电子购物系统的设计与实现【源码+lw+部署文档】

包含论文源码的压缩包较大&#xff0c;请私信或者加我的绿色小软件获取 免责声明&#xff1a;资料部分来源于合法的互联网渠道收集和整理&#xff0c;部分自己学习积累成果&#xff0c;供大家学习参考与交流。收取的费用仅用于收集和整理资料耗费时间的酬劳。 本人尊重原创作者…...

编程日记 2024/6/29 22:39:47

CSS实现动画

CSS实现动画主要有三种方式&#xff1a;transition&#xff0c;transform&#xff0c;和animation1。以下是一些详细的逻辑&#xff0c;实例和注意事项&#xff1a; Transition&#xff1a;transition可以为一个元素在不同状态之间切换的时候定义不同的过渡效果。例如&#xff…...

编程日记 2024/6/29 22:38:46

Python+Pytest+Allure+Yaml+Jenkins+GitLab接口自动化测试框架详解

PythonPytestAllureYaml接口自动化测试框架详解 编撰人&#xff1a;CesareCheung 更新时间&#xff1a;2024.06.20 一、技术栈 PythonPytestAllureYamlJenkinsGitLab 版本要求&#xff1a;Python3.7.0,Pytest7.4.4,Allure2.18.1,PyYaml6.0 二、环境配置 安装python3.7&…...

编程日记 2024/6/29 22:35:41

[OtterCTF 2018]Bit 4 Bit

我们已经发现这个恶意软件是一个勒索软件。查找攻击者的比特币地址。** 勒索软件总喜欢把勒索标志丢在显眼的地方&#xff0c;所以搜索桌面的记录 volatility.exe -f .\OtterCTF.vmem --profileWin7SP1x64 filescan | Select-String “Desktop” 0x000000007d660500 2 0 -W-r-…...

编程日记 2024/6/29 22:33:38

计算机视觉全系列实战教程 (十四)：图像金字塔（高斯金字塔、拉普拉斯金字塔）

1.图像金字塔 (1)下采样 从G0 -> G1、G2、G3 step01&#xff1a;对图像Gi进行高斯核卷积操作&#xff08;高斯滤波&#xff09;step02&#xff1a;删除所有的偶数行和列 void cv::pyrDown(cv::Mat &imSrc, //输入图像cv::Mat &imDst, //下采样后的输出图像cv::Si…...

编程日记 2024/6/29 22:32:37

正确重写equals和hashcode方法

1. 重写的原因 如有个User对象如下&#xff1a; public class User {private String name;private Integer age; }如果不重写equals方法和hashcode方法&#xff0c;则&#xff1a; public static void main(String[] args) {User user1 new User("userA", 30);Us…...

编程日记 2024/6/29 22:31:36

各类郑州网站建设/百度网盘电脑版官网

《Pytext实战》 一 快速入门 1. Pytext简介 pytext框架介绍 2. 安装Pytext pytext的安装步骤 2. 训练模型 文本分类 3. 执行模型 将训练后的模型导出并应用 二 训练高级模型 1. 意图识别与插槽模型 Intent-Slot model 2. 多层级意图识别与插槽填充 Hierarchical intent and slo…...

编程日记 2024/12/29 2:58:51

网站css不调用了/关键词百度网盘

GPIO 一、什么是GPIO&#xff1f; 首先应该理解什么是GPIO。GPIO&#xff0c;英文全称为General-Purpose IO ports&#xff0c;也就是通用IO口。在嵌入式系统中经常有数量众多&#xff0c;可是结构却比較简单的外部设备/电路&#xff0c;对这些设备/电路有的须要CPU为之提供控…...

编程日记 2024/12/28 23:47:34

电商网站开发人员结构/2022最近比较火的营销事件

今天刚学的java继承&#xff0c;然后把课后编程题的实例做一个总结 编程要求&#xff1a;设计一个动物声音“模拟器”&#xff0c;希望模拟器可以模拟许多动物的叫声&#xff0c;要求如下。 编写抽象类Animal Animal抽象类有两个抽象法cry()和getAnimalName(),即要求各种具体…...

编程日记 2024/12/28 22:19:15

哪些网站做外贸/百度网盘app下载安装 官方下载

利用freemarker对参数进行校验这篇文章主要用到的技术点&#xff1a; 自定义注解的使用反射机制SAX解析xmlFreemarker的运用我们在工作中经常需要上传excel文件&#xff0c;然后在对文件中的字段进行校验。如果文件里的字段是反复出现&#xff0c;或者文件的字段比较多的话&…...

编程日记 2024/12/28 22:03:04

中国建设银行个人登录/无锡网络优化推广公司

Spring Boot总体来说&#xff0c;搭建还是比较容易的&#xff0c;特别是Spring Cloud全家桶&#xff0c;简称亲民微服务。但在发展趋势中&#xff0c;容器化技术已经成熟&#xff0c;面对巨耗内存的Spring Boot&#xff0c;小公司表示用不起。如今&#xff0c;很多刚诞生的JAVA…...

编程日记 2024/12/28 17:23:49

广州公司建站/seo网站优化知识

在设计ROS系统工程的时候我们一般是按照多节点的形式设计的&#xff0c;这样做的好处在于将系统按模块进行了隔离&#xff0c;而坏处主要有两个&#xff0c;一是中间的数据传输是按照网络进行的&#xff0c;延时比较大&#xff0c;这个问题的解决办法比较多&#xff0c;比如内存…...

编程日记 2024/12/28 8:49:11