ViewDesignEngine/docs/feedback/VDE-009.md

id, status, severity, category, date, reporter

id	status	severity	category	date	reporter
VDE-009	open	medium	doc	2026-07-27	ViewDesign

VDE-009: 缺少 C API 文档和示例

问题描述

ViewDesignEngine 提供了 C API (vde_capi) 用于跨语言绑定，但头文件没有详细文档注释；没有使用示例；不清楚每个函数的输入/输出约定（谁分配内存，谁释放）；集成时只能通过阅读源码理解 API 用法。

影响文件

• include/vde/capi/vde_capi.h
• src/capi/vde_capi.cpp

ViewDesign 侧 Workaround

暂无，需要通过阅读源码理解 API。

建议修复方向

1. 为 vde_capi.h 添加 doxygen 文档
2. 提供 examples/capi/ 目录下的使用示例
3. 文档化内存管理约定（调用者 vs 库管理）

---

此文件由 ViewDesign 工程自动生成。处理完成后请更新 status 字段。