Initial Commit (Working)

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "doxygen-awesome-css"]
+	path = doxygen-awesome-css
+	url = https://github.com/jothepro/doxygen-awesome-css

NEW_README.md

@@ -0,0 +1,31 @@
+# fbb_ws63 SDK 文档
+
+## 介绍
+
+  fbb_ws63代码仓为支持ws63和ws63e解决方案SDK，该SDK包从统一开发平台FBB（Family Big Box，统一开发框架，统一API）构建而来，在该平台上开发的应用很容易被移植到其他星闪解决方案上，有效降低开发者门槛，缩短开发周期，支持开发者快速开发星闪产品。本 SDK 文档从 fbb_ws63 的源代码生成，包括了 LiteOS 相关函数（不包括 POSIX 兼容层部分）、OSAL 相关函数、 UAPI 相关函数与其它驱动 hal 层驱动和没有被分类的杂项函数。本页面的生成脚本：https://rad1o.cn/goodspeed/doxy_ws63
+
+## 快速上手
+
+1. 开发环境搭建[参考tools目录README](https://gitee.com/HiSpark/fbb_ws63/tree/master/tools)
+2. 资料手册、IO复用关系、用户手册指南表[参考docs/board目录README](https://gitee.com/HiSpark/fbb_ws63/tree/master/docs/board)
+3. 硬件原理图[参考docs/hardware](https://gitee.com/HiSpark/fbb_ws63/tree/master/docs/hardware)
+
+## 设备驱动快速索引（对应 WS63V100 设备驱动 开发指南）
+
+|      名称       | 描述                                                     |
+| :------------: | ------------------------------------------------------- |
+| @ref drivers_driver_pinctrl | Pinctrl 控制器用于控制 IO 管脚的复用功能。 |
+| @ref drivers_driver_gpio | GPIO（General-purpose input/output）是通用输入输出的缩写，是一种通用的 I/O 接口标准。 |
+| @ref drivers_driver_uart | UART（Universal Asynchronous Receiver/Transmitter）是通用异步收发器的缩写，是一种串行、异步、全双工的通信协议，用于设备间的数据传输。 |
+| @ref drivers_driver_spi | SPI（Serial Peripheral Interface）是一种高速、全双工、同步的通信总线。 |
+| @ref drivers_driver_i2c | IIC（Inter-Integrated Circuit）也叫做 I2C，译作集成电路总线，是一种串行通信总线。 |
+| @ref drivers_driver_adc | ADC（Analog-to-Digital Converter）模/数转换器，是指将连续变化的模拟信号转换为离散的数位信号的器件。 |
+| @ref drivers_driver_dma | DMA（Directory Memory Access）直接存储器访问是一种完全由硬件执行数据交换的工作方式。 |
+| @ref drivers_driver_pwm | PWM（Pulse Width Modulation）脉宽调制模块通过对一系列脉冲的宽度进行调制，等效出所需波形。 |
+| @ref drivers_driver_watchdog | WDT（Watchdog）看门狗计时器，一般用于 CPU 运行异常时实现异常恢复，如果系统正常运行，会定期喂狗，以防止计时器超时。 |
+| @ref drivers_driver_timer | Timer 是一种用来计时和产生定时事件的重要模块。 |
+| @ref drivers_driver_systick | Systick 是单片机系统中的一种硬件设备或功能模块，用于提供精确的时间基准和定时功能。 |
+| @ref drivers_driver_tcxo | TCXO（Temperature Compensated Crystal Oscillator）是一种温度补偿晶体振荡器。 |
+| @ref drivers_driver_sfc | Flash 是一种非易失快闪记忆体技术，又称为闪存，通常支持 SPI 协议。 |
+| @ref drivers_driver_efuse | eFuse 的全称是“电子熔断器”（electronic fuse），是一种可编程电子保险丝，是一种用于存储信息和保护芯片的非易失性存储器件。 |
+

README.md

@@ -1,3 +1,20 @@
 # doxy_ws63
 
-Doxyfile for fbb_ws63
+Doxyfile for fbb_ws63
+
+Build Instructions:
+
+```
+# Prepare SDK Source
+git clone --depth=1 https://gitee.com/HiSpark/fbb_ws63.git
+cd fbb_ws63
+# Prepare Doxyfile Source
+git clone --depth=1 --recursive https://rad1o.cn/goodspeed/doxy_ws63.git
+cp -rf doxy_ws63/* .
+# Build it
+COMMIT_HASH=$(git rev-parse --short HEAD) doxygen
+
+# Artifact sits in fbb_ws63/docOut/html.
+```
+
+Please note, the Doxyfile here has customization that you may not want, such as threads, searching, footer etc.

doxygen-awesome-css

@@ -0,0 +1 @@
+Subproject commit 568f56cde6ac78b6dfcc14acd380b2e745c301ea

footer.html

@@ -0,0 +1,18 @@
+<!-- HTML footer for doxygen 1.9.8-->
+<!-- start footer part -->
+<!--BEGIN GENERATE_TREEVIEW-->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    $navpath
+    <li class="footer" style="float: left !important;">由 <a href="https://www.050821.xyz/">William Goodspeed</a> 维护 | E-mail: gongzl@stu.hebust.edu.cn | Wechat: a23333344 | ALSO CHECKOUT <a href="https://github.com/goodspeed34/ws63flash/">WS63FLASH</a>!</li>
+    <li class="footer">$generatedby <a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion </li>
+  </ul>
+</div>
+<!--END GENERATE_TREEVIEW-->
+<!--BEGIN !GENERATE_TREEVIEW-->
+<hr class="footer"/><address class="footer"><small>
+$generatedby&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion
+</small></address>
+<!--END !GENERATE_TREEVIEW-->
+</body>
+</html>