生成的 API 参考
SDK Javadoc 的生成、审查与发布状态。
SDK Javadoc 必须从对应的 Turboism 源码生成,并在完成审查后才能同步到 SDK 文档站点。
文档更新流程
当公共 SDK、SDK 说明或版本发生变化时:
- 使用源码仓库的
:sdk:javadocGradle 任务生成 Javadoc; - 核对精确版本,并拒绝带有 snapshot 标识的输出;
- 审查每个可公开搜索的包和类型;
- 确认内部实现类型和未经批准的 Preview API 没有被当作公共契约;
- 检查生成文字中是否包含私有资料、本地路径、凭据、宿主日志或仅供内部实现使用的验证信息;
- 将通过审查的结果同步到文档站点;
- 运行文档 lint、类型检查和生产构建。
生成成功不代表可以发布。如果生成的公共面或版本尚未准备好,应保持现有托管 Javadoc 不变,并在本页记录阻塞原因。
当前状态
已经生成并审查 0.43.3 的 release 模式候选结果。版本标识正确,也不包含 snapshot 标识,但尚未同步,原因包括:
ActiveReadProjections仍可公开搜索,而它自己的说明将其定义为不属于稳定插件 API 的内部辅助类型;- 生成的常量值页面包含一个无效的本地锚点;
- 多个公共类型仍使用 Preview API 表述,需要先批准公共参考策略。
SDK 更新脚本现在会自动读取版本、扫描生成结果中的受限内容和无效本地链接、对 Preview API 表述要求明确批准,并在同步后验证文档站点。
在这些问题解决前,请使用 SDK API 指南和公共 SDK 源码声明。不要依赖当前托管的 HTML 参考作出发布、部署或兼容性声明。