Doxygen基础篇（三）——增加导航窗口
Doxygen基础篇（三）——增加导航窗口
前言：
为了更方便查看，Doxygen生成的HTML文档可以增加导航栏显示。
1 导航栏配置
打开Doxygen向导，选择 Wizard -> Topics -> Output ，勾选 with navigation panel 选项，该选项表示生成带有导航窗口的文档。
Doxygen基础篇（三）——增加导航窗口
前言：
为了更方便查看，Doxygen生成的HTML文档可以增加导航栏显示。
1 导航栏配置
打开Doxygen向导，选择 Wizard -> Topics -> Output ，勾选 with navigation panel 选项，该选项表示生成带有导航窗口的文档。
重新生成文档，效果如下。
重新生成文档，效果如下。
Doxygen基础篇（三）——增加导航窗口
前言：
为了更方便查看，Doxygen生成的HTML文档可以增加导航栏显示。
1 导航栏配置
打开Doxygen向导，选择 Wizard -> Topics -> Output ，勾选 with navigation panel 选项，该选项表示生成带有导航窗口的文档。
重新生成文档，效果如下。
本博客所有文章除特别声明外，均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来源 OnlyCalm's Blog！
wechat- alipay
相关推荐
2021-08-15
Doxygen基础篇（四）——增加宏定义
Doxygen基础篇（四）——增加宏定义前言： c/c++这样带宏定义的编程语言经常会用到预编译宏，部分代码是由宏控制的可选代码，但要让Doxygen正确处理这些代码可能需要手动添加宏定义。 1 代码被Doxygen忽视 预编译宏中的代码可能被Doxygen忽视，生成的文档中不含有这部分代码的说明。如果一段代码被预编译宏控制为可选代码，预编译宏在其他文件甚至编译器的配置中定义，那么Doxygen不能解析到该宏定义，导致不能生成这段代码的文档说明，解决办法需要手动在Doxygen中添加相关的宏定义。 2 添加宏定义 &emps;打开Doxygen向导，找到关于预定义宏的设置项。 Expert -> Topics -> Preprocessor -> PREDEFINED...
2021-07-31
Doxygen基础篇（一）——安装Doxygen
Doxygen基础篇（一）——安装Doxygen前言： Doxygen可以像JavaDoc那样提取代码中的注释生成文档手册，它不仅是一种文档生成工具，更是一种注释的规范，要写出规范的代码掌握Doxygen是必要的。 1 Doxygen简介 Doxygen 是一种开源跨平台的代码文档生成工具。Doxygen可将按照其规定格式编辑的注释信息提取转换生成方便阅读的说明文档，文档格式有LATEX、RTF等，支持C, Objective-C, C#, PHP, Java, Python等语言。 2 安装Doxygen2.1...
2021-08-01
Doxygen基础篇（二）——配置Doxygen
Doxygen基础篇（二）——配置Doxygen前言： 在Windows上可以方便的通过GUI配置Doxygen，按照配置生成代码帮助手册。 1 配置Wizard1.1 配置Project 打开 Doxygen GUI frontend ，选择 Wizard 标签页下 Project 选项进行该页面的配置，该选项下是关于项目的一些基础设置。 Doxygen基础篇（二）——配置Doxygen前言： 在Windows上可以方便的通过GUI配置Doxygen，按照配置生成代码帮助手册。 1 配置Wizard1.1 配置Project 打开 Doxygen GUI frontend ，选择 Wizard 标签页下 Project 选项进行该页面的配置，该选项下是关于项目的一些基础设置。 Specify the working directory from which doxygen will run: 为安装的Doxygen的工作目录，路径要选到安装目录下的bin目录； Project...
2020-03-10
c代码Doxygen注释规范
c代码Doxygen注释规范前言： 良好得注释风格利于后期维护和团队协作开发，使得代码逻辑清晰，意图明了。Doxygen是一种能自动提取代码内注释生成版主文档的开源软件，它是跨平台的。非开源项目也许并不需要有这样一份帮助文档，但Doxygen的注释规范也不失为一种好的风格，可以推广遵守。 1 Doxygen注释规范模板1.1 文件注释模板123456789/** * @file 文件名（*.h/*.c） * @brief 该模块功能的简介。 * @details 使用该模块有哪些细节注意等。 * @author 创建该文件的人名。 * @data 该文件的创建日期（2020-03-10）。 * @version 文件或模块版本号（V1.0.0）。 * @copyright 版权所属公司。 */ 若某项无相关的说明，中文写 无 ，英文写 None ，此时末尾不加标点，若有相关的说明，则建议正常使用标点符号，包括句末标点。 1.2 函数注释模板1.2.1 完整格式1234567891011121314151617181920/** *...
2018-12-23
浅显易懂的GCC使用教程
浅显易懂的GCC使用教程前言： 2018-12-17天气暖，属于冬日里出太阳。最近在学习使用gvim，想着抛弃对IDE的依赖同时也是想了解编译的过程，但除了学习gvim繁多的指令外还得先学习使用gcc编译程序。这篇文章将会用浅显易懂的方式记录下gcc的基本使用，同时也不忘扩展探究。 什么是GCC，它能干什么？ GCC、gcc、g++三者有何关系？ 开始开发前该做什么准备？ gcc常用指令讲解？ 1 什么是gcc，它能干什么？ GCC(GNU Compiler Collection)即GNU编译器套件，属于一种编程语言编译器，其原名为GCC（GNU C Compiler）即GNU c语言编译器，虽然缩写一样但是功能上区别很大。GCC的初衷是为GNU操作系统专门编写的一款编译器，原本的GNU是专用于编译C代码，现如今已扩展为可以编译C、C++、Java、Objective-C等多种编程语言的编译器集合了。这篇文章主要介绍gcc或g++的使用。 2 GCC、gcc、g++三者有何关系？ gcc（GUN C...
2019-07-27
GVim管理“工程”？
GVim管理”工程“？前言： 经常看到新手朋友问Vim怎么管理工程之类的问题，其实这是对Vim的误解，它只是个编辑器而不是IDE，它不负责工程管理。工程管理应该交给CMake之类的（不然你还指望能像vscode那样有WorkSpace功能吗？目前我没发现）。如果你只是想用GVim方便的管理文件和文件夹的话还是能做到的，具体可以用Vim自带的目录树管理插件或用NerdTree之类的插件。 用过之后你可能会郁闷遇到“如何让GVim启动就默认打开某个目录或文件？”，更方便点“如何想让哪个文件或文件夹用GVim启动就能立刻启动？”。这篇博客就是回答这两个问题的。 1 如何让GVim启动就默认打开某个目录或文件？1.1...
评论
ValineGitalk
Powered By Valine
v1.5.2
v1.5.2
