生成された 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:javadocタスクをリリースバージョンモードで実行して Javadoc を生成する。 - 正確なバージョンを確認し、snapshot 表記のある出力は拒否する。
- 公開検索可能なすべてのパッケージと型をレビューする。
- 内部実装型と未承認の Preview API が公開契約として提示されていないことを確認する。
- 生成テキストに私有資料、ローカルパス、認証情報、ホストログ、実装専用の検証情報が含まれていないか確認する。
- レビュー済みの出力をドキュメントサイトへ同期する。
- ドキュメントの lint、型チェック、本番ビルドを実行する。
生成の成功だけでは公開の承認になりません。
レビュー済みの公開例外
公開中のリファレンスは v0.43.10 のコンパイル済み公開面をそのまま反映しているため、レビューが「隠れた問題」ではなく例外と判定した 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 リファレンスだけに基づいて、リリース、配備、互換性を判断しないでください。