使用doxygen生成ESP8266_RTOS_SDK的api文档

最新推荐文章于 2023-08-09 23:54:21 发布
最新推荐文章于 2023-08-09 23:54:21 发布
阅读量288 收藏
点赞数
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lqysgdb/article/details/119237538
版权

1. 简述

最近学习ESP8266_RTOS_SDK，想要查看api文档，但是发现乐鑫官网只有老版本（v2.0）的api，目前github上发布的最新版本是v3.4（ESP8266_RTOS_SDK的github地址）。在仓库的docs文件夹里有生成api的doxygen文件和python的脚本，但是直接使用都会报错。

2. 修改docs/文件夹下的Doxyfile文件

在这里插入图片描述
需要修改图中INPUT下的路径，会根据以下路径的头文件中的doxygen语法生成对应的文档。

在这里插入图片描述
这里选择生成对应的文档。

3. 生成api文档

在命令行直接使用以下命令根据Doxyfile文件配置生成文档。

$ doxygen
Enterprise0
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
ESP8266API参考手册
10-16
乐鑫公司提供的ESP8266芯片，本资源为该芯片的API参考手册，中文版。
乐鑫ESP8266 SDK编程手册
01-19
ESP8266 SDK编程手册讲解了该芯片API的使用，可以方便用户定制自己的物联网解决方案。
ESP8266 RTOS SDK学习之官方SDK文档分析
夏沫的杂物间
10-06 2437
写在前面： 本文章旨在总结备份、方便以后查询，由于是个人总结，如有不对，欢迎指正；另外，内容大部分来自网络、书籍、和各类手册，如若侵权请告知，马上删帖致歉。 虽然说现在官方已经出版了 V3.0+的版本，但是最新的未必是最好的，尤其是拿来学习分析，所以下面我用 ESP8266_RTOS_SDKV1.5:https://github.com/espressif/ESP8266_RTO...
ESP8266学习记录6——常用的API整理（持续更新）
康娜喵的原创博客
04-17 2651
零之前言 这里先说一下，这只是我个人的对ESP8266 rtos3.0+版本的整理与记录，可能与其他人的有差别。本人能力有限，如果有问题，请斧正，谢谢。 一.内核类 0.说明： 创建一个task，就类似于创建一个线程，然后我能力有限，不好说清楚那种感觉。。。 可以看看官方文档，挺好理解的FreeRTOS 1.创建、销毁： 创建： static BaseType_t xTaskCreate(Task...
ESP8266 RTOSSDK3.0 的工程同步到3.4
可可芯意的博客
03-21 6256
一、为什么要用最新的3.4 因为ESP_IDF 4.4的 kconfig 和RTOS SDK的不兼容，我这里是想8266和32用同一个虚拟机，也不想各种折腾，所以就升级到3.4了 二、修改步骤 注意看对应的GCC，这里匹配到的是 8.4.0，3.0的用5.2，2.x的用4.8 ，nonos也用4.8 smartconfig的start函数的参数有区别,sc回调去掉了，直接放到event里面去了 3.0的SDK： ESP_ERROR_CHECK( esp_smartconfig_start(sc
Doxygen_源代码文档自动生成器的使用笔记.pdf
11-06
google 上搜了很久的关于 Doxygen 使用方法的咚咚，只不过都是英文，而且都很多的规则。实际上大家只需要告诉基本的规则就可以。下面是我对 Doxygen 的摸索 首先熟知 Doxygen 产生的文件的基本结构
使用 doxygen 生成 chm 文档
03-07
详细介绍doxygen各种注释标准、方法，并生成chm的过程
doxdocgen：从VS Code中的源代码生成doxygen文档
02-01
通过启动Doxygen注释块并按Enter，此VS Code扩展可以即时生成Doxygen文档。 目录 产品特点 对准 有关其工作原理，请参见 属性 析构函数 广泛的定制 档案说明 功能指针 经营者 参量 退货类型 智能文字 支持的智能...
使用Doxygen生成文档
06-14
ppt,QT环境，使用注释生成详细设计文档的方法
ESP8266 乐鑫官方SDK入门指南
07-25
ESP8266 SDK 入门指南 NONOS-SDK RTOS-SDK
ESP8266 RTOS SDK编程开发手册（中文版）
01-20
Esp8266 wifi芯片的RTOS sdk编程开发手册，中文版本。
ESP8266 RTOS SDK API
12-01
ESP8266 RTOS SDK API 参考_20b-esp8266_rtos_sdk_api_reference_v1.4.0
ESP8266_RTOS_SDK 3.4 ubuntu20.10编译环境搭建
lenyound的博客
11-06 1164
最近在研究ESP8266,发觉这真是一个好玩的东西，感觉自己来迟了，错过了几百万！ windows的编译环境我根据手册搭建完成，但是感觉好慢啊。网上有人收Linux下编译快的一批。 我特意来尝试了一下，我是个linux小白，根据网上的资料一步一步来，走了很多弯路，花了几天时间终于 可以编译了。给大家分享下过程，自己也做个记录。 1. 我用的是虚拟机VMware，大家自行下载安装。 2. 下载ubuntu20.10 http://mirrors.aliyun.com/ubuntu...
ESP8266 SDK 入门指南.pdf 物联网芯片开发文档常见问题api参考RTOS SDK API
坐井说天阔
01-06 857
部分文档预览图 城通下载还算比较方便，至少我觉得比百度云方便。 ESP8266 SDK 入门指南.pdf: https://545c.com/file/20096151-416479871 ESP8266 Non-OS SDK API 参考.pdf: https://545c.com/file/20096151-416480161 ESP8266EX 常见问题.pdf: http...
ESP8266：SDK
INT_TANG的博客
07-11 1706
1. SDK 1.1 non-OS 和 RTOS 两种版本SDK 1.2 ESP8266 FW 1.3 Non-OS SDK 1.4 RTOS SDK 2. Flash布局（烧录代码） 由于提供的SDK对Flash有布局要求（代码的链接地址有要求以及分区保存信息），因此我们在烧录代码时，需要注意Flash的分区，只有下载到正确的分区才能正常运行。（基本上设计都会分区，将某部分规划为自有用途） ........................
Doxygen 使用 和配置
黎国溥
10-09 1636
目录 一、默认配置生成 二、自定义配置生成（推荐） 1）项目基础设置 2）Expert设置 2.1 Project 2.2 Build 2.3 input 2.4Source Browser​ 2.5 HTML 2.6 Dot 3 Run 点击运行即可 一、默认配置生成 选择要生成说明文档的代码，其所在的目录 使用默认配置生成： 查看生成的输出结果： ...
2022 ESP8266_RTOS_SDK 开发环境搭建（VSCode）
weixin_43808708的博客
05-23 3371
文章目录前言1.需要下载3样东西1.1 Windows 多合一工具链和 MSYS2 压缩包文件1.2 下载ESP8266_RTOS_SDK1.3 下载工具链2.用到的指令.VSCode插件 前言 自己要会点git的基础,这里不说明 1.需要下载3样东西 1.1 Windows 多合一工具链和 MSYS2 压缩包文件 https://dl.espressif.com/dl/esp32_win32_msys2_environment_and_esp2020r2_toolchain-20200601.zip
ESP8266的SDK（ESP8266_RTOS_SDK v3.3 环境搭建)明细
最新发布
lin1243110603的博客
08-09 242
Esp8266开发环境大致分为两种： Arduino for esp8266 esp8266 SDK 其中SDK的开发方式分为代操作系统和不带操作系统（RTOS），不带操作系统的方式已经不再开发新的功能，只修复bug，而带操作系统的SDK还在维护中。 对比两种开发方式： Arduino：环境搭建简单，开发简单，但相对效率较低（Arduino对IO操作进行了封装，代码上简单了，其实封装的过程多产生了许多资源消耗） SDK：环境搭建劝退了许多开发者（资料不足，命令行），效率高。
doxygen 生成boost文档
05-30
Doxygen是一个用于自动生成文档的工具，它可以从源代码中提取注释信息，并将其转化为HTML、LaTeX、RTF等格式的文档。Doxygen支持多种编程语言，包括C++、Java、Python等，也支持很多格式的注释，如C++风格、Java风格...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值