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

原创已于 2022-05-26 20:49:29 修改 · 437 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#ubuntu #linux #运维

于 2022-05-23 22:11:10 首次发布

本文档详细介绍了如何在Ubuntu20.04上通过apt命令和Doxygen官网bin文件两种方式安装Doxygen。安装完成后，不仅能够使用Doxygen从C源码中提取文档，还将配置LaTeX环境以生成PDF，同时集成plantUML来绘制UML图，助力代码文档的完整性和专业性。

搭建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这个图形化的配置工具

官网入门指南

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

飞箭前面的蜗牛

关注关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

Doxygen的安装与使用及注释语法

夏夜晚风_的博客

11-26

1968

文章目录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 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。提供

Doxygen使用教程1--安装配置

yizhou2010的专栏

01-09

2194

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

参与评论您还未登录，请先登录后发表或查看评论

doxygen安装包

06-30

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

Doxygen下载安装使用教程（附安装包）

最新发布

数据结构和算法教程（C语言版）

09-30

983

Doxygen是一款自动化代码文档生成工具，支持C/C++、Java、Python等十余种编程语言。它能将代码注释自动转换为HTML/PDF/Word等多种格式文档，适用于开源项目、团队协作、毕业设计等场景。安装过程简单，支持Windows/Linux/MacOS三大平台，并可搭配Graphviz生成调用关系图。通过图形化界面配置，只需填写必要参数即可快速生成带超链接、可搜索的规范化技术文档，显著提升开发效率。

doxygen 安装

天空中的太阳和月

09-13

1318

doxygen 安装安装一下库 $ sudo apt-get install flex $ sudo apt-get install bison step1.下载源码 $ git clone https://github.com/doxygen/doxygen.git step2.编译 $ cd doxygen $ mkdir build $ cd build $ cmake...

Doxygen安装使用

杰克十里温

04-16

1742

它可以将结构化的信息以图表的形式显示出来。doxygen可以调用Graphviz显示函数的调用关系。在 html 文件夹下，找到 index.html 文件，用浏览器，打开它，就可以查看生成的文档了。你可以在这里指定项目名称，它最终会显示在页眉(header)和浏览器标签上。如果你只想生成 HTML 文档，可以通过这个开关禁用 LaTeX 输出。第 1769 行：禁用 LaTeX 输出。项目简介会以略小的字号显示在页眉上。第 926 行：包含子目录。第 35 行：项目名称。第 47 行：项目简介。

doxygen安装centos

07-29

- *1* *2* [搭建Doxygen环境从代码中提取文档——Doxygen安装](https://blog.youkuaiyun.com/github_19061021/article/details/124934040)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm...

Doxygen 1.8.0 安装包及使用说明

Doxygen 是一个广泛使用的开源文档生成工具，主要用于从源代码中自动生成高质量的技术文档。标题中的“doxygen-1.8.0-setup”表明这是一个 Doxygen 版本为 1.8.0 的安装程序（setup），适用于 Windows 操作系统，其...

Graphviz 2.24插件用于Doxygen生成类图与调用图

Doxygen 是一款流行的开源文档生成工具，支持多种编程语言（如 C++、C、Java、Python 等），能够从源代码注释中提取信息，自动生成结构化的 API 文档。然而，Doxygen 本身并不具备图形渲染能力，无法直接绘制复杂的...

Qt-CMake-Boost-Doxygen模板：高效跨平台软件开发

Doxygen是一个文档生成工具，它能够从源代码中提取文档的注释，并生成包括HTML、PDF或RTF在内的格式化文档。Doxygen广泛用于C++、C、Java、Objective-C、Python、IDL等编程语言。 - **注释提取**: Doxygen可以解析...

DBUnit 2.4.9 源码API文档解析

从描述内容来看，该 API 文档是由源码中的注释直接生成的，这意味着文档内容与实际代码高度一致，具备较高的准确性和实时性。Doxygen 是一种广泛使用的自动化文档生成工具，支持多种编程语言，尤其在 C++ 和 Java ...

Doxygen (1): 安装及设置

qq_37896521的博客

01-18

4691

Doxygen 安装 & 配置

linux doxygen工具安装

qq_54600953的博客

07-05

318

【代码】linux doxygen工具安装。

doxygen安装使用

leno的专栏

11-30

899

1.先下载解压解压附件中Doxygen.zip（点击打开链接），安装doxygen，没有注意事项全都下一步安装即可 2.安装graphviz-2.38.msi，没有注意事项全都下一步安装即可 3.安装htmlhelp.exe 3.配置doxygen

doxygen安装与使用

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

08-08

715

Output和Diagrams也没什么好动的。

Doxygen 1.7.4 安装配置指南(windows)

lostaway的专栏

05-26

6646

Doxygen 是一个支持 C/C++，以及其它多种语言的跨平台文档生成工具。如同 JavaDoc, doxygen 直接从源文件中提取符合 doxygen 注释规范的注释，生成文档[1]。 1、安装 1.1 安装 Doxygen 1.7.4(Windows) 地址：f

Ubuntu20.04安装Doxygen

happycrcr的博客

05-22

1914

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档文章目录前言一、先安装支持工具二、安装最新版本的Doxygen参考前言提示：这里可以添加本文要记录的大概内容： Doxygen 是一个程序的文件产生工具，可将程序中的特定注释转换成为说明文件。大部分有用的注释都是属于针对函数、类型等等的说明。所以，如果能依据程序本身的结构，将注释经过处理重新整理成为一个纯粹的参考手册，对于后面利用您的程序代码的人而言将会减少许多的负担。对于未归档的源文件，也可以通过配置Doxygen来提取代码结构.

doxygen 安装与常用配置

优快云博客

04-13

1646

参考 doxygen教程-7.1-小练习:@file命令_qq_28867779的博客-优快云博客安装 sudo apt-get install doxygen sudo apt-get install graphviz sudo apt-get install doxygen-doc doxygen-gui 生成配置文件首先进入到项目目录（最少是你要生成文档的所有代码的父级目录）: doxygen -g 该命令会在当前路径生成名为Doxyfile的配置文件 Dox...

linux下doxygen的安装与使用说明

manyouxianfeng的专栏

05-12

747

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