linux dot命令,linux dot 安装
安装doxygen 安装包 doxygen-1.7.4.linux.bin.tar.gz(可在官网下载)
命令:
1) tar xvfz doxygen-1.7.4.linux.bin.tar.gz
2) cd doxygen-1.7.4
3) ./configure
4) make
5) make install
安装后需留意下doxyg的路径,例如:/usr/bin/doxygen
配置Doxygen工作环境 步骤:
6) 进入项目目录(test为例说明) cd test/
7) 生成配置文件 Doxygen –g
l 默认生成的配置文件名为 "Doxyfile",也可以采用 "doxygen -g your-cfg-filename" 命令格式指定所生成的配置文件名。如无特殊需要,采用默认的配置文件名即可。
l Doxyfile 文件内容非常多,大概 1000 多行,不过其中约 4/5 都是注释,每个配置选项都有一段详细的注释。日后,如果对 Doxygen 各配置选项的意义有一定了解,可以在生成配置文件的命令中添加 "-s" 选项,生成不含注释的配置文件,操作如下:$ doxygen -s -g
3)配置文件的相应设置 ,这里已经有个模板Doxyfile(test文件夹下),可以根据需要更改相应设置
项目名称,将作为于所生成的程序文档首页标题
PROJECT_NAME = “Test
文档版本号,可对应于项目版本号,譬如 svn、cvs 所生成的项目版本号
PROJECT_NUMBER = "1.0.0
程序文档输出目录
OUTPUT_DIRECTORY = doc/
程序文档语言环境
OUTPUT_LANGUAGE = Chinese
如果是制作 C 程序文档,该选项必须设为 YES,否则默认生成 C++ 文档格式
OPTIMIZE_OUTPUT_FOR_C = YES
对于使用 typedef 定义的结构体、枚举、联合等数据类型,只按照 typedef 定义的类型名进行文档化
TYPEDEF_HIDES_STRUCT = YES
在 C++ 程序文档中,该值可以设置为 NO,而在 C 程序文档中,由于 C 语言没有所谓的域/名字空间这样的概念,所以此处设置为 YES
HIDE_SCOPE_NAMES = YES
让 doxygen 静悄悄地为你生成文档,只有出现警告或错误时,才在终端输出提示信息
QUIET = YES
只对头文件中的文档化信息生成程序文档
FILE_PATTERNS = *.h
递归遍历当前目录的子目录,寻找被文档化的程序源文件
RECURSIVE = YES
示例程序目录
EXAMPLE_PATH = example/
示例程序的头文档 (.h 文件) 与实现文档 (.c 文件) 都作为程序文档化对象
EXAMPLE_PATTERNS = *.c \
*.h
递归遍历示例程序目录的子目录,寻找被文档化的程序源文件
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
#让doxygen从配置文件所在的文件夹开始,递归地搜索所有的子目录及源文件
RECURSIVE = YES
#在最后生成的文档中,把所有的源代码包含在其中
SOURCE BROWSER = YES
$这会在HTML文档中,添加一个侧边栏,并以树状结构显示包、类、接口等的关系
GENERATE TREEVIEW = ALL
程序源码文档化 准备好 Doxygen 的工作环境后,就需要根据 Doxygen 所定义的注释规则,对程序源码进行文档化。换句话说,就是在对程序源码添加注释时,要按照 Doxygen 的游戏规则来搞。
Doxygen 的注释类型可分为:
l 行间注释:注释语句不与程序源码出现在同一行,主要用于注释头文件中出现的结构体 (struct)、枚举 (enum)、联合 (uion) 等数据类型,以及程序接口的功能与使用约定;
l 行内注释:注释语句与程序源码出现在同一行内,主要用于代码的局部注释。
注释的种类有很多,下面是其中的一种:
Doxygen 认可的行间注释标记见下例:
/**
这是行间注释标记示例 */
Doxygen 认可的行内注释标记见下例:
typedef struct { double coord[3]; /// 这是行内注释示例
}M2_3D_Point;
程序文档生成 现在开始生成程序文档,将终端的工作目录定位在 test 目录,然后键入:
$ doxygen your-cfg-filename
your-cfg-filename 是 Doxygen 配置文件名,如果是使用 "doxygen -g" 生成的配置文件——Doxyfile,那么可以在终端里仅键入 "doxygen" 命令即可生成程序文档。
生成的文档位于 test/doc/html 目录中,使用浏览器打开该目录中的 index.html 文件,即可看到自己的工作成果。
Doygen 集成到codeBlocks 5.1 配置步骤 在codeBlocks工作界面中,Tools->Configure tools ->Add
Name :doxygen
Executable:/usr/bin/doxygen
Parameters:配置文件名,(如果doxygen –g 生成的默认配置文件,在这里不需要写)
Working directory:test(要生成程序文档的项目路径)
5.2 使用: 当需要生成程序文档时:Tools->doxygen 即可。生成的文档位于 test/doc/html 目录中,使用浏览器打开该目录中的 index.html 文件,即可看到自己的工作成果
linux dot命令,linux dot 安装相关推荐
- linux objdump命令,Linux objdump命令
一.简介 objdump命令是用查看目标文件或者可执行的目标文件的构成的gcc工具. 二.选项 三.实例 1)显示文件头信息 objdump -f test 2)显示Section Header信息 ...
- linux unset命令,Linux unset命令
Linux unset命令 Linux unset命令用于删除变量或函数. unset为shell内建指令,可删除变量或函数. 语法unset [-fv][变量或函数名称] 参数:-f 仅删除函数. ...
- linux sfdisk命令,Linux sfdisk命令
Linux sfdisk命令 Linux sfdisk命令是硬盘分区工具程序. sfdisk为硬盘分区工具程序,可显示分区的设置信息,并检查分区是否正常. 语法 sfdisk [-?Tvx][-d ] ...
- linux(linux常用命令,软件安装,vim编辑器)
linux2 linux常用命令 软件安装 vim编辑器 linux常用命令 系统信息 date 显示系统日期 cal / cal 2018 关机 (系统的关机.重启以及登出 ) shutdown - ...
- Linux相关命令及软件安装教程
@font-face { font-family: "Times New Roman" } @font-face { font-family: "宋体" } @ ...
- linux② 常用命令 , python3, django安装
目录 一.常用命令 二.下载和安装 一.常用命令 1.常识命令 ① w 显示终端连接数 ②pwd 我在哪 ③whoami 我是谁 ④which 命令 找到命令的 ...
- linux bind命令,Linux初学者DNS配置指南(一)安装Bind
手把手教你如何配置Linux下的DNS(一)安装Bind 最近配置linux下DNS时,遇到些问题,查了网上的很多资料,内容都比较全面,但是没有一个能让linux初学者,按照所写的步骤一步一步执行下去 ...
- linux 限速命令,Linux路由器限速设置详细教程
linux的开源和免费使得越来越多的厂家用它来做防火墙和路由器,如海蜘蛛,飞鱼星等,其实我们也可以用linux来打造一台高性能的路由器.下面就以red hat为例(其他版本大同小异)教大家做一台能限速 ...
- linux 限速命令,linux 路由器限速实现方法
linux 路由器限速实现方法 linux的开源和免费使得越来越多的厂家用它来做防火墙和路由器,今天本文用linux来打造一台高性能的能够限速的路由器.文章就以red hat为例教大家在linux下进 ...
- type在linux什么命令,Linux type命令
用途说明 type命令用来显示指定命令的类型.一个命令的类型可以是如下几种: alias 别名 keyword 关键字,Shell保留字 function 函数,Shell函数 builtin 内建命 ...
最新文章
- python安装成功的图标_ubuntu下:安装anaconda、环境配置、软件图标的创建、成功启动anaconda图形界面...
- 如何将分表汇总到总表_轻松实现多表汇总数据(多表汇总成单表)
- java类获取声明,获取用于MethodInvocation的实际类而不是声明类 - java
- abd.exe 需要下java吗_Abd.exe文件下载|
- nexttick使用场景_使用Jest实现Vue自动化测试
- TCP之三:TCP/IP协议中backlog参数(队列参数)
- fat linux 链接,FAT格式磁盘镜像制作方法
- STL容器 之 list
- 树莓派4B引脚定义及运行实例
- 企业微信企业邮箱设置,微信企业邮箱如何设置?
- 神来之笔之傅里叶变换(频谱)
- RGB颜色值转换为十进制
- 让你提前认识软件开发(8):memset()与memcpy()函数
- 如何有效提高生产车间的生产效率呢?
- 一文搞懂 Traefik2.1 的使用
- html星座代码,各星座详细页面.html
- count distinct
- 06 方法定义及重载
- 无监督学习 聚类分析②
- JD旗舰店店铺商品详情接口代码对接教程