- 博客(11)
- 收藏
- 关注
RSS订阅原创 doxygen教程-10-生成调用关系图
文章目录生成调用关系图安装 graphviz生成函数调用关系图(callgraph)通过 `CALL_GRAPH = YES` 生成函数调用关系图小栗子深入细节通过`@callgraph` 命令生成函数调用关系图栗子1 - 简单加上 `@callgraph`栗子2 - 给被调用的函数也加上 `@callgraph`栗子3 - 更自动的解决方法栗子4 - 被调用的函数没有被注释(documented)总结生成函数被调用图(callergraph)栗子生成结构体和文件的调用关系图生成调用关系图许多 IDE
2021-11-07 02:52:09
9158
2
原创 doxygen教程-9-使用Markdown
文章目录Markdown 简介在注释中使用 Markdown利用 Markdown 编写网页标题及首页用 special commands 编写网页Markdown 简介Markdown 是一种广泛使用的, 用于编写文档的语法. 相比于常用的 Word, 利用 Markdown 可以非常方便地控制格式, 从而专注于写作. 当然, 论功能, Word 是完胜的, 但是在程序开发的语境下, Markdown 是更舒适的选择(表格和图片是硬伤 T.T );在 github, gitee 等代码托管网站, 仓
2021-10-31 22:32:07
2185
原创 doxygen教程-8-插入公式
文章目录插入公式渲染公式编写公式插入公式渲染公式doxygen 支持 latex 公式. 有两种途径渲染公式, 第一种是先把公式转化成图片, 然后在网页中显示图片, 这要求安装 latex 编译器, dvips, 和 GhostScript. 第二种是在配置文件中设置USE_MATHJAX = YES , 于是公式文本会被原样复制到 HTML 中, 并由客户端的 JavaScript 渲染公式.编写公式有以下几种插入公式的方法(不全):行内公式, 嵌入在普通文字中. 使用 \f$ 或 \f(
2021-10-31 16:07:42
761
原创 doxygen教程-7.1-小练习:@file命令
小练习-file命令前面我们已经提到 @file 是一个 structural command, 现在我们通过一个小练习来具体体会这一点.参数为 comment.c首先创建目录 hello_doxygen2, 然后创建两个空白的文本文件 hello.c, comment.c, 两个文件的内容分别如下:hello.c/** @brief variable in hello.c */int var_in_hello = 0;comment.c/** @file comment.c @d
2021-10-31 11:49:27
844
原创 doxygen教程-7-special commands
文章目录命令的分类命令的格式常用命令文件注释函数注释`@param`其他在前面的文章中, 我们已经多次用到了 @brief, @details, @file 这几个命令. 本文将具体地介绍这些命令是如何工作的. doxygen 提供了大量的指令 并介绍一些常用的命令以供参考.以下内容整理自官方手册 doxygen_manual-1.9.2 -> Reference Manual -> Special Commands 一节命令的分类special commands 这个词语, 官方手册又
2021-10-30 22:02:30
290
原创 doxygen教程-6-把注释放在其他位置
文章目录把注释放到成员之后Structural commands把注释放到成员之后在前面的介绍中, 我们都是把注释放在函数之前的, 而对于结构体, 联合, 枚举这些复合类型, 把注释放到它们的成员的后面或许会更方便. 对于变量, 我们通常也喜欢把注释放到定义的后边. 要做到这一点, 语法很简单, 只要在前面注释的基础上, 多加一个小于号 < 就成了, 例如:int var1; /*!< Detailed description after the member in Qt style */
2021-10-27 22:32:23
430
翻译 doxygen教程-5-编写注释
文章目录一些概念entitySpecial comment blocktypes of description注释的格式brief 和 detail小结一些概念本篇将简要介绍如何编写注释, 在这之前, 让我们先来了解一些概念.entity我以为官方会给这个词一个定义的, 但是我搜索了手册, 找到最初几处用到这个词的地方, 发现都没有解释 entity 的含义, 而是直接用了. 不过也不是很难理解, 结合该词出现处的文义来看, entity 就是任何可以被注释的事物的统称: class, functi
2021-10-24 14:31:08
445
原创 doxygen教程-4-快速上手配置文件
文章目录快速上手 doxygen 配置文件配置文件的格式常用 tag 简介OUTPUT_DIRECTORYINPUT 和 RECURSIVEEXTRACT_ALLOUTPUT_LANGUAGEGENERATE_LATEX前面提到使用 doxygen 实际上就是做好两件事: 写配置和写注释, 本文将初步介绍 doxygen 的配置文件.快速上手 doxygen 配置文件doxygen 的配置文件是一个纯文本文件. 虽然用 Windows 自带的记事本就可以编辑, 但是为了更好的体验, 以下使用 Note
2021-10-16 18:07:23
3661
原创 doxygen教程-3-初探doxygen
文章目录用好 doxygen 的两件事Hello Doxygen编写配置文件并输出文档终于开始正题啦, 下面开始介绍如何使用 doxygen. 首先要确定能在终端运行 doxygen, 如果不行的话, 请看上一篇教程.(突然发现我的行文还是挺啰嗦的, 在正题之前, 居然能整出两篇长文…)用好 doxygen 的两件事用好 doxygen , 说起来倒也简单, 就是做好两件事: 写配置文件和写注释. 学到后面就会发现, 我们一直在跟这两件事情打交道.其实这里说"写注释"并不够全面, 实际上我们还可
2021-10-11 22:52:28
410
原创 doxygen教程-2-下载和运行
下载 doxygen要下载最正规的程序, 当然要去官网啦. 如图所示, 进入 doxygen 官网的下载页面, 找到 “A binary distribution for Windows”, 列出的就是 Windows 下可用的程序的. 由于公司的电脑会拦截安装程序运行, 所以我选择下载免安装的版本, 即图中的 “64-bit version”.如果懒得进官网找, 我把下载链接复制过来了: https://www.doxygen.nl/files/doxygen-1.9.2.windows.x64.b
2021-10-10 23:11:32
1792
原创 doxygen教程-1-简介
什么是 doxygendoxygen 是一款为 C++ 代码生成文档的工具. 只要按照 doxygen 的语法编写注释, doxygen 就可以从源码中提取出这些注释, 并生成文档. 如果源码中没有符合 doxygen 语法的注释, doxygen 也可以在其生成的文档中展示代码的结构, 如调用关系图, 继承图等. 如此, 就可以使得文档始终与代码保持一致.opencv 的在线文档 就是用doxygen 生成的, 如下图doxygen 的语法很简单, 例如下面代码的注释可以生成下图的文档:/**
2021-10-10 18:29:49
849
空空如也
空空如也
TA创建的收藏夹 TA关注的收藏夹
TA关注的人