生成的 API 参考

当前托管的 SDK Javadoc 版本、生成方式,以及适用的审查例外。

SDK Javadoc 必须从对应的 Turboism 源码生成,并在完成审查后才托管到 SDK 文档站点。

当前托管版本

项目值
生成来源Turboism v0.43.10 发行版源码
自述版本sdk 0.43.10 API
公共包数量59
可搜索的公共类型数量691
托管地址turboism.dev/sdk/index.html

文档更新流程

当公共 SDK、SDK 说明或版本发生变化时:

  1. 在 release 版本模式下使用源码仓库的 :sdk:javadoc 任务生成 Javadoc;
  2. 核对精确版本,并拒绝带有 snapshot 标识的输出;
  3. 审查每个可公开搜索的包和类型;
  4. 确认内部实现类型和未经批准的 Preview API 没有被当作公共契约;
  5. 检查生成文字中是否包含私有资料、本地路径、凭据、宿主日志或仅供内部实现使用的验证信息;
  6. 将通过审查的结果同步到文档站点;
  7. 运行文档 lint、类型检查和生产构建。

生成成功不代表可以发布。

已审查的发布例外

当前托管内容反映 v0.43.10 已编译的公共面,因此其中包含两项被审查认定为例外、而非隐藏问题的内容。每次同步都会重新检查这两项;不在此列表中的任何阻塞项仍会导致同步失败。

ActiveReadProjections 是 public,但不是契约

dev.turboism.sdk.cubism.ActiveReadProjections 会编译为 public 类,因为 CubismFacade 与 CubismReadCapabilityService 的默认方法共用它的辅助方法。该类的 Javadoc 明确说明它不属于稳定插件 API 面。

  • 之所以托管它的页面,是因为该类型已存在于已发行的字节码中。
  • 它不是受支持的扩展点。请不要调用它,也不要把它当作兼容性承诺。
  • 只要该类型仍为 public,就必须在本页和 SDK API 指南 中继续标注它为非契约类型。

已修复的常量值锚点

JDK 的 Javadoc 生成器会在 constant-values.html 中写入指向 #dev.turboism 的目录链接,却不输出对应的目标。同步脚本会补上缺失的锚点,并在每次运行时报告该修复;其他任何失效链接仍会导致失败。

Preview API 表述

部分公共类型仍以 Preview 贡献的形式描述自己。这类表述说明该类型受能力和版本约束,并不意味着它属于 Stable 产品线。可用性仍取决于权限、能力 Provider,以及精确的 Cubism Editor 版本,详见 SDK API 指南。

如何使用本参考

  • 请把生成的 Javadoc 视为当前源码的说明,而不是独立的稳定性承诺。Turboism 源码仓库中已审查的二进制 API 基线才是兼容性判据。
  • 关于行为指导、版本限制和就绪边界,请先阅读 SDK API 指南。
  • 不要仅凭托管的 HTML 参考作出发布、部署或兼容性声明。