From 81be40086f90738a3bafe23c248063e6346ae55b Mon Sep 17 00:00:00 2001 From: xfy911 Date: Sun, 7 Jun 2026 09:06:12 +0800 Subject: [PATCH] =?UTF-8?q?docs(plan):=20=E6=9B=B4=E6=96=B0=E8=A7=84?= =?UTF-8?q?=E5=88=92=E6=96=87=E4=BB=B6=20=E2=80=94=20=E6=A0=87=E8=AE=B0=20?= =?UTF-8?q?Doxygen=20=E6=B3=A8=E9=87=8A=E5=AE=8C=E6=88=90=E5=B9=B6?= =?UTF-8?q?=E6=9B=B4=E6=96=B0=E5=BE=85=E5=8A=9E=E6=B1=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .cocoon-plan.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/.cocoon-plan.md b/.cocoon-plan.md index 07d872c..f4f2c3c 100644 --- a/.cocoon-plan.md +++ b/.cocoon-plan.md @@ -68,10 +68,11 @@ - WebSocket：RFC 6455 握手、文本/二进制帧 echo、ping/pong/close、广播/频道 - 反向代理：路径前缀匹配 → HTTP/1.1 后端，X-Forwarded-For / X-Forwarded-Proto 透传，JSON 配置支持 - Windows 兼容性：跨平台抽象层 platform.h + platform.c，CMakeLists.txt 自动检测平台，Makefile 在 Windows 下自动链接 ws2_32 +- **函数级 Doxygen 中文注释已覆盖 config.c、log.c、tls.c（2026-06-07）** ## 待办池 -1. **[低] Doxygen 中文注释** — 各模块函数级注释待完善 +1. **[中] Doxygen 中文注释** — 继续覆盖剩余模块：http.c、http2.c、server.c、static.c、middleware.c、proxy.c、websocket.c、platform.c 2. **[低] 性能优化** — 连接池复用、零拷贝优化、压缩预缓存 3. **[低] 配置文件 JSON Schema 验证** — 配置文件格式校验 4. **[x] 编译警告修复** — stringop-truncation 警告已消除 ✅ 2026-06-07 @@ -82,6 +83,13 @@ ## 最近行动记录 +- 2026-06-07: **本轮行动 — 为 config.c、log.c、tls.c 添加函数级 Doxygen 注释** + - `config.c`: 为 JSON 解析器内部函数（parser_init、parser_skip_ws、parser_next_token、token_expect、token_str_dup、token_to_long、str_to_log_level）和公共 API（config_load_from_file、config_merge）添加完整 Doxygen 注释 + - `log.c`: 为日志级别转换和输出函数（level_str、log_set_level、log_set_prefix、log_get_level、log_output、log_error、log_warn、log_info、log_debug）添加注释 + - `tls.c`: 为 TLS 连接管理（tls_lookup、tls_map_set、tls_map_clear）、Memory BIO 操作（socket_read、socket_write_all、flush_wbio）、ALPN 回调（tls_alpn_select_cb）和公共 API（tls_create_context、tls_destroy_context、tls_has_context、tls_accept、tls_read、tls_write、tls_close、tls_has_connection、tls_negotiated_http2）添加注释 + - `http2.c`: 移除过时的 TODO 占位注释（请求体收集已实现） + - 编译零警告，142 个单元测试 + 80 项集成测试全部通过 + - 推送到 main（9da9bd9） - 2026-06-07: **本轮行动 — 修复编译警告与测试清理** - `config.c`: 将 `strncpy` 替换为 `memcpy` + 显式 null 结尾，消除 `-Wstringop-truncation` 警告 - `proxy.c`: 同上，修复 `proxy_add_rule` 中的 `strncpy` 警告