ubuntu doxygen 安装与常用配置
ubuntu doxygen 安装与常用配置
- ubuntu 安装与使用doxygen
- 安装doxygen
- 安装Graphviz
- 生成doxygen配置文件
- 常用配置
- 根据配置生成doxygen文档
ubuntu 安装与使用doxygen
主要步骤如下:
安装doxygen—> 安装Graphviz—>生成doxygen配置文件—>修改doxygen配置文件—>生成doxygen文档
安装doxygen
sudo apt-get install doxygen
安装Graphviz
sudo apt-get install graphviz
生成doxygen配置文件
doxygen -s -g
注释:上述s 和 g 分别表示simple和generate
常用配置
常用选项如下:
# 项目名称,将作为于所生成的程序文档首页标题
PROJECT_NAME = “Test”
# 文档版本号,可对应于项目版本号,譬如 svn、cvs 所生成的项目版本号
PROJECT_NUMBER = "1.0.0
# 程序文档输出目录
OUTPUT_DIRECTORY = /home/user1/docs
# 程序文档输入目录
INPUT = /home/user1/project/kernel
# 程序文档语言环境
OUTPUT_LANGUAGE = Chinese
# 只对头文件中的文档化信息生成程序文档
FILE_PATTERNS =
# 递归遍历当前目录的子目录,寻找被文档化的程序源文件
RECURSIVE = YES
# 如果是制作 C 程序文档,该选项必须设为 YES,否则默认生成 C++ 文档格式
OPTIMIZE_OUTPUT_FOR_C = YES
#提取信息,包含类的私有数据成员和静态成员
EXTRACT_ALL = yes
EXTRACT_PRIVATE = yes
EXTRACT_STATIC = yes
# 对于使用 typedef 定义的结构体、枚举、联合等数据类型,只按照 typedef 定义的类型名进行文档化
TYPEDEF_HIDES_STRUCT = YES
# 在 C++ 程序文档中,该值可以设置为 NO,而在 C 程序文档中,由于 C 语言没有所谓的域/名字空间这样的概念,所以此处设置为 YES
HIDE_SCOPE_NAMES = YES
# 让 doxygen 静悄悄地为你生成文档,只有出现警告或错误时,才在终端输出提示信息
QUIET = YES
# 递归遍历示例程序目录的子目录,寻找被文档化的程序源文件
EXAMPLE_RECURSIVE = YES
# 允许程序文档中显示本文档化的函数相互调用关系
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
REFERENCES_LINK_SOURCE = YES
# 不生成 latex 格式的程序文档
GENERATE_LATEX = NO
# 在程序文档中允许以图例形式显示函数调用关系,前提是你已经安装了 graphviz 软件包
HAVE_DOT = YES
CALL_GRAPH = YES
CALLER_GRAPH = YES
#在最后生成的文档中,把所有的源代码包含在其中
SOURCE BROWSER = YES
$这会在HTML文档中,添加一个侧边栏,并以树状结构显示包、类、接口等的关系
GENERATE TREEVIEW = ALL
根据配置生成doxygen文档
doxygen Doxyfile
ubuntu doxygen 安装与常用配置相关推荐
- wireshark使用教程 linux,Linux入门教程:ubuntu下安装wireshark(以及配置非root),这个强大的工具可以捕...
Linux入门教程:ubuntu下安装wireshark(以及配置非root),这个强大的工具可以捕 Wireshark是世界上最流行的网络分析工具.这个强大的工具可以捕捉网络中的数据,并为用户提供关 ...
- Ubuntu Linux安装PyQt5并配置Qt Designer
Ubuntu Linux安装PyQt5并配置Qt Designer PyQt5 创建独立环境 创建conda环境 安装pyqt5 查看版本 安装图形界面Qt Designer pycharm 配置 v ...
- JetBrains软件安装及常用配置
JetBrains软件安装及常用配置 Date:2021-01-13 1 安装 JetBrains提供的软件十分好用,在此记录安装以及常用设置,方便之后查看 Jetbrains官网 产品介绍如下: W ...
- Arch Linux的安装与常用配置
制作安装镜像U盘 镜像系统配置 联网 虚拟机或网线 dhcpcd WiFi systemctl start wpa_supplicant.service nmcli dev wifi list nmc ...
- Nginx的安装与常用配置
前言:本文是基于虚拟机上的centOS 7对Nginx的安装,可以使用uname -a查看centOS系统版本,本文用来记录安装nginx的步骤和相关命令,方便日后使用时查看. Nginx的安装与运行 ...
- Nginx 集群安装以及常用配置详解开机自启动
Nginx 配置文件详解 main: 全局配置 event: 配置工作模式以及连接数 http: http 模块相关配置 server 虚拟主机配置,可以有多个 location 路由规则,表达式 u ...
- Ubuntu 之 atom 安装以及 常用配置
安装方式如下: 打开终端,使用以下命令安装: sudo add-apt-repository ppa:webupd8team/atom sudo apt-get update sudo apt-get ...
- ubuntu服务器mysql等常用配置命令
平时用的时候记录下来的一些,有些凌乱稍微整理了一下: 1.本地ubuntu远程ssh linux云服务器: 1.用linux的ssh可以直接通过ip地址访问云服务器$ssh ubuntu@ip(ssh ...
- ubuntu下安装 python 常用软件
1.用于科学计算的常用包: sudo apt-get install python-numpy python-scipy python-matplotlib ipython ipython-noteb ...
最新文章
- 这些重大科技领域问题,听听专家怎么说
- 【TYVJ】1359 - 收入计划(二分)
- Candy Box (easy version)
- 【LeetCode】——根据前序和中序遍历构建二叉树
- LeetCode 1026. 节点与其祖先之间的最大差值
- [渝粤教育] 西南科技大学 会计学原理 在线考试复习资料(2)
- Metamask + remix:在ropsten测试链上取出已经部署的合约并进行一些操作
- SheetJS 读取excel文件转出json
- Ubuntu下,curl 安装
- 如何培训新进的软件测试人员
- Linux下键盘测试工具
- 论文阅读:Face-Mic: Inferring Live Speech and Speaker Identity via Subtle Facial Dynamics Captured by
- 〔转载〕20条欠揍短消息
- PEGA(Low-Code App Builder)Describing a data object
- 如何用计算机算出男朋友的身高,【趣味物理】如何用物理方法测出男生的真实身高?...
- MatLab中的多项式拟合(lsqcurvefit函数的非线性曲线拟合)
- 互联网医院网络安全等保建设方案
- 2010年互联网风云人物
- oracle查询语句中select from where group by having order by的解释与应用
- IOS AppDelegate详解
热门文章
- zoj 1713 Haiku Review
- 微信小程序云开发详解
- 【iOS】音频播放之AVAudioPlayer,AVPlayer,AVQueuePlayer
- PCI总线在VxWorks中的实现
- 建筑设计和绘图的CAD软件AutoCAD Architecture 2024版本在Windows系统的下载与安装配置
- android studio中使用github (上集)
- 微信小程序从入坑到放弃二十九:一个小场景搞懂冒泡事件bindtap和catchtap的区别
- SAP自动付款(Automatic payment)
- c语言结构体指针使用方法,C语言结构体指针的使用方法
- 【Lintcode】1015. Find Eventual Safe States