生成された 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、その説明、またはバージョンが変わったときは、次の順で進めます。

  1. ソースリポジトリの :sdk:javadoc タスクをリリースバージョンモードで実行して Javadoc を生成する。
  2. 正確なバージョンを確認し、snapshot 表記のある出力は拒否する。
  3. 公開検索可能なすべてのパッケージと型をレビューする。
  4. 内部実装型と未承認の Preview API が公開契約として提示されていないことを確認する。
  5. 生成テキストに私有資料、ローカルパス、認証情報、ホストログ、実装専用の検証情報が含まれていないか確認する。
  6. レビュー済みの出力をドキュメントサイトへ同期する。
  7. ドキュメントの lint、型チェック、本番ビルドを実行する。

生成の成功だけでは公開の承認になりません。

レビュー済みの公開例外

文書化した基準は 5e0f8b02c のコンパイル済み公開面をそのまま反映しているため、レビューが「隠れた問題」ではなく例外と判定した 2 件を含みます。どちらも同期のたびに再検査され、この一覧にない阻害要因は引き続き実行を失敗させます。

ActiveReadProjections は public だが契約ではない

dev.turboism.sdk.cubism.ActiveReadProjections は public クラスとしてコンパイルされます。CubismFacade と CubismReadCapabilityService のデフォルトメソッドがそのヘルパーを共有しているためです。クラスの Javadoc は、これが安定プラグイン API 面に属さないと明記しています。

  • ページをホストしているのは、この型がすでに生成元のバイトコードに存在するためです。
  • サポート対象の拡張点ではありません。呼び出さず、そのシグネチャを互換性の約束として扱わないでください。
  • この型が public である限り、本ページと SDK API ガイド で非契約として明示し続けます。

修復した constant-values のアンカー

JDK の Javadoc 生成器は constant-values.html に #dev.turboism への目次リンクを書き出しますが、対応するターゲットを出力しません。同期スクリプトが欠落したアンカーを補い、その修復を毎回報告します。それ以外の壊れたリンクは依然として失敗になります。

Preview API の表現

一部の公開型は今も自身を Preview コントリビューションとして説明しています。この表現は、その型が機能とバージョンに依存することを示すものであり、Stable 系列に属するという意味ではありません。可用性は権限、機能 Provider、および正確な Cubism Editor バージョンに依存します。詳細は SDK API ガイド を参照してください。

このリファレンスの使い方

  • 生成された Javadoc は現在のソースの説明として扱い、独立した安定性の約束とはみなしません。互換性の判定基準は、Turboism ソースリポジトリでレビュー済みのバイナリ API ベースラインです。
  • 挙動の指針、バージョン制限、準備状況の境界については、まず SDK API ガイド を参照してください。
  • ホストされている HTML リファレンスだけに基づいて、リリース、配備、互換性を判断しないでください。