Doxygen基础篇（三）——增加导航窗口
Doxygen基础篇（三）——增加导航窗口
前言：
为了更方便查看，Doxygen生成的HTML文档可以增加导航栏显示。
1 导航栏配置
打开Doxygen向导，选择 Wizard -> Topics -> Output ，勾选 with navigation panel 选项，该选项表示生成带有导航窗口的文档。
重新生成文档，效果如下。
本博客所有文章除特别声明外，均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来源 OnlyCalm's Blog！
相关推荐
2021-08-15
Doxygen基础篇（四）——增加宏定义
Doxygen基础篇（四）——增加宏定义前言： c/c++这样带宏定义的编程语言经常会用到预编译宏，部分代码是由宏控制的可选代码，但要让Doxygen正确处理这些代码可能需要手动添加宏定义。 1 代码被Doxygen忽视 预编译宏中的代码可能被Doxygen忽视，生成的文档中不含有这部分代码的说明。如果一段代码被预编译宏控制为可选代码，预编译宏在其他文件甚至编译器的配置中定义，那么Doxygen不能解析到该宏定义，导致不能生成这段代码的文档说明，解决办法需要手动在Doxygen中添加相关的宏定义。 2 添加宏定义 &emps;打开Doxygen向导，找到关于预定义宏的设置项。 Expert -> Topics -> Preprocessor -> PREDEFINED 。在该项中添加需要的宏设置。 当定义的宏带值时，使用 = 进行赋值，但等号前后不能加空格，否则无法识别。例如： SWITCH=1
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 Windows下安装Doxygen Windows下载官网找到exe文件下载安装，它捆绑了32位和64位版本，根据操作系统自动选择合适的版本安装。里面包含了手册和GUI。 在点击 I accept the agreement 然后点击 Next...
2021-08-01
Doxygen基础篇（二）——配置Doxygen
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 name: 该项目的名称； Project synopsis: 该项目的项目简介； Project version or id: 项目版本或id； Project logo: 选择项目的logo图标，文件为图片格式； Source code directory: 工程源代码的目录，需要被提取注释生成文档的代码应该在此目录下； Scan recursively:...
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/** *...
2025-08-16
FreeRTOS基础篇（一）——介绍
FreeRTOS基础篇（一）——介绍前言： FreeRTOS 是目前全球最受欢迎的开源实时操作系统（RTOS）之一，在嵌入式系统领域具有广泛的影响力。 1 介绍 RTOS即Real Time OS，也就是实时操作系统。实时操作系统又分为硬实时和软实时，硬实时不允许超时，软实时系统超时的结果每那么严格。RTOS操作系统的核心内容在于实时内核。而FreeRTOS（Free Real-Time Operating System）是一款开源免费的RTOS，专为嵌入式系统和微控制器（MCU）设计。它以其轻量级、高可靠性、可移植性和免费开源（MIT 许可证）的特点，成为嵌入式开发领域的标杆之一。 FreeRTOS 的影响力体现在其广泛的市场应用、强大的开源生态、持续的技术创新以及行业认可度上。随着物联网和嵌入式设备的快速发展，FreeRTOS...
2025-12-06
FreeRTOS基础篇（七）——事件组和任务通知
FreeRTOS基础篇（七）——事件组和任务通知前言： 在嵌入式实时系统中，任务间的同步与通信是构建复杂应用的核心。FreeRTOS 提供了多种机制来协调任务执行，其中事件组（Event Group）和任务通知（Task Notifications）因其高效性和灵活性被广泛使用。事件组适用于多事件的逻辑组合等待，而任务通知则是最快速的任务间通信方式，无需额外创建队列或信号量。本文通过实例详解两者的工作原理、API 使用场景及性能差异，帮助开发者在实际项目中做出更优选择，提升系统响应速度与资源利用率。 1 事件组（Event Group）1.1 介绍 事件组是一种允许一个或多个任务等待多个“事件”中某些或全部发生的同步机制。它使用一个24位（STM32上通常为23位可用）的位图来表示不同的事件标志（bit flags），每个bit可代表一个特定事件。 典型用途： 等待多个条件中的任意一个发生（如：按键按下 OR 定时器超时） 等待多个条件全部满足（如：网络连接 + 时间同步 + 配置加载完成） 1.2...
评论
ValineGitalk
