生成的 API 参考
当前托管的 SDK Javadoc 版本、生成方式,以及适用的审查例外。
线上 SDK Javadoc 会自动跟随最新正式 Stable,并从该发行版的精确源码提交生成。发布元数据 记录线上版本和源码。下方保留的基线快照用于说明指定版本的示例和已审查例外。
文档基线:Stable 0.67.4
| 项目 | 值 |
|---|---|
| 生成来源 | Turboism Stable 源码 5e0f8b02c(标签 v0.67.4) |
| 自述版本 | sdk 0.67.4 API |
| 公共包数量 | 63 |
| 可搜索的公共类型数量 | 948 |
| 托管地址 | turboism.dev/sdk/index.html |
此文档快照由 Stable 0.67.4 发布标签生成。示例请使用该发行版的 turboism-sdk-0.67.4.jar 和 turboism-event-processor-0.67.4.jar 编译。模板设置脚本默认使用 stable 渠道;请核对 gradle.properties 和文件名,确认实际编译版本。
相对 0.67.0 参考页的变更
与此前的 0.67.0 参考页相比,当前托管参考新增 15 个公共类型:
dev.turboism.sdk.cubism.model:AtlasPageAppendPlan、Drawables.SourceGeometryRequest、ModelImagePlacement、WarpMorphSnapshot(含WarpMorphSnapshot.Form和WarpMorphSnapshot.Key);dev.turboism.sdk.cubism.textureatlas:TextureAtlasPackingException(含TextureAtlasPackingException.Reason)、TextureAtlasPageSize,以及TextureAtlasPolygonLayoutPlanner(标注为@Incubating);dev.turboism.sdk.plugin:AbstractTurboismPlugin;dev.turboism.sdk.ui.appearance:PaletteRowAction(含PaletteRowAction.State);dev.turboism.sdk.ui.settings:SettingsControl.FilePath;dev.turboism.sdk.ui.window:TurboismProgressDialog。
文档更新流程
当公共 SDK、SDK 说明或版本发生变化时:
- 在 release 版本模式下使用源码仓库的
:sdk:javadoc任务生成 Javadoc; - 核对精确版本,并拒绝带有 snapshot 标识的输出;
- 审查每个可公开搜索的包和类型;
- 确认内部实现类型和未经批准的 Preview API 没有被当作公共契约;
- 检查生成文字中是否包含私有资料、本地路径、凭据、宿主日志或仅供内部实现使用的验证信息;
- 将通过审查的结果同步到文档站点;
- 运行文档 lint、类型检查和生产构建。
生成成功不代表可以发布。
已审查的发布例外
文档基线反映 5e0f8b02c 已编译的公共面,因此其中包含两项被审查认定为例外、而非隐藏问题的内容。每次同步都会重新检查这两项;不在此列表中的任何阻塞项仍会导致同步失败。
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 参考作出发布、部署或兼容性声明。