生成済み API リファレンス
SDK Javadoc の生成、レビュー、公開状況。
SDK Javadoc は対応する Turboism ソースから生成し、レビューが完了した後にのみ SDK ドキュメントサイトへ同期します。
ドキュメント更新手順
public SDK、その説明、またはバージョンが変更された場合は、次の手順を行います。
- ソースリポジトリの
:sdk:javadocGradle タスクで Javadoc を生成する。 - 正確なバージョンを確認し、snapshot 表示を含む出力を拒否する。
- public に検索できるすべてのパッケージと型をレビューする。
- 内部実装型や未承認の Preview API が public contract として表示されていないことを確認する。
- 生成された文章に、非公開データ、ローカルパス、認証情報、ホストログ、内部実装だけで使う検証情報が含まれていないことを確認する。
- レビュー済みの出力をドキュメントサイトへ同期する。
- ドキュメントの lint、型チェック、本番ビルドを実行する。
生成に成功しただけでは公開を承認したことになりません。生成された public surface またはバージョンの準備ができていない場合は、現在ホストされている Javadoc を変更せず、このページに問題を記録します。
現在の状況
0.43.3 の release モード候補を生成してレビューしました。バージョン表示は正しく、snapshot 表示も含まれていませんが、次の理由により同期していません。
ActiveReadProjectionsは public に検索できる一方、その説明では安定した plugin API に含まれない内部 helper とされています。- 生成された定数値ページに無効なローカルアンカーが含まれています。
- 複数の public 型に Preview API という表現が残っており、public reference の方針を承認する必要があります。
SDK 更新スクリプトは、バージョンの自動取得、生成結果に含まれる制限対象コンテンツと無効なローカルリンクの検査、Preview API 表現への明示的な承認要求、同期後のドキュメントサイト検証を行うようになりました。
これらの問題が解決するまでは、SDK API ガイドと public SDK のソース宣言を使用してください。現在ホストされている HTML リファレンスを release、deployment、compatibility の根拠にしないでください。