ypc
/
RTU_ALL_AI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
55 Commits 1 Branch 0 Tags 1.4 MiB
Commit Graph

5 Commits

Author SHA1 Message Date
ypc ecbdf483b6 docs(libweb_server): Web 管理服务模块详细 API 参考文档 
12 个章节完整覆盖:
- 模块概述 + 与原工程对比
- 文件结构 + 单线程事件驱动架构图
- 核心数据结构 (stru_ws_sig / stru_ws_session / enum_ws_sig_type)
- 接口函数 (X-Macro 入口 / ws_send_all / ws_send_one / ws_send_binary / 异步通道)
- WebSocket 协议 (JSON CRUD / 增量推送格式 / 远程命令 / 文件管理)
- 内部函数 (ws_sig_add/del/set / ws_make_sig_json / ws_push_task / ws_cmd_exec)
- X-Macro 注册 / 依赖关系 / 编译构建 / 运行验证 / JavaScript 使用示例
 2026-07-08 18:02:21 +08:00
ypc db1ee1e979 docs: RTU 模块 + Mongoose API 参考文档 
- docs/system/RTU/API-RTU.md: RTU 完整文档（531行）
  X-Macro 框架/启动流程/数据结构/新增模块指南
- docs/protocol/libmongoose/API-libmongoose.md: mongoose 文档（347行）
  HTTP/WebSocket/定时器 API + 集成约束
- docs/README.md: 新增 system/ + protocol/libmongoose 索引
- COMPLETION.md: 更新 RTU + mongoose 完成状态
 2026-07-08 17:36:15 +08:00
ypc 16e3efb19c docs(libcomm): API 参考文档 + 进度更新 + 索引 
- docs/public/libcomm/API-libcomm.md: 模块概述/数据结构/7个API详情/使用示例/依赖关系
- docs/README.md: 新增 libcomm 条目 + 阶段2依赖关系图
- COMPLETION.md: libcomm 标记完成 + 添加缺失测试清单
 2026-07-08 13:37:38 +08:00
ypc 9d12019961 chore: update build system and docs for new modules 
- release/src/public/makefile: 添加 libxml/libcmd/libdatacenter 到 SUBDIRS
- SPEC.md: 补全 libdatacenter §11 完整功能规格（300+ 行）
- docs/README.md: 更新模块索引和依赖关系图
- 10/10 模块 x86 全量编译通过
 2026-07-07 17:30:18 +08:00
ypc 44419ec729 docs: 创建完整 API 参考文档（9 个文档, 1005 行） 
目录结构: docs/public/ 镜像 src/public/, 每个模块一个 API-xxx.md
文档内容: 模块概述+数据结构+接口详细说明+使用示例+依赖关系

覆盖模块:
- docs/README.md (总索引, 依赖关系图)
- myBase.h (公共宏/字节序/数据类型常量)
- liblist (11 API, 侵入式链表, 含完整代码示例)
- liblog (17 API, 异步日志, 消息池+批量+文件轮转)
- libfunc (65 函数, 7 大分类, 分组文档)
- libmd5 (4 API, RFC 1321, 流式计算示例)
- libtask (21 API, 定时器+事件+消息队列, 三个独立示例)
- libcJSON (开源库, 解析/生成 全流程示例)
- libmy_xxhash (开源库, XXH32/XXH64 快速哈希)

文档规范已存入 /memories/doc-spec.md
 2026-07-07 15:16:17 +08:00