API リファレンス

Kotlin API リファレンスは、Dokka を用いて KDoc コメントから生成されます。

注釈

API リファレンスは、本ドキュメントと並んで /api/ に配置されます。上記リンクはデプロイ済みサイトを指しています。ローカルでドキュメントを実行する場合は、まずプロジェクトルートで ./gradlew dokkaGenerate を実行して API ドキュメントを生成してください。

API リファレンスをローカルで生成する

# From the project root (not sphinx-docs/)
./gradlew dokkaGenerate

# Output lives at build/dokka/html/
open build/dokka/html/index.html

含まれる内容

src/main/kotlin/com/rescript/plugin/ 配下の public および internal のすべての Kotlin 宣言:

  • クラス、オブジェクト、インターフェース、列挙型

  • トップレベル関数およびプロパティ

  • KDoc コメント、@param、@return、@see アノテーション

  • 各宣言に対応する GitHub へのソースリンク

除外される内容

  • 自動生成された JFlex レクサー (RescriptFlexLexer.java) — API として利用価値がないため

  • private メンバー（Dokka はデフォルトで public と internal のみを表示します）

主要なパッケージ

パッケージ

目的

com.rescript.plugin.lang

レクサー、パーサー、トークンタイプ

com.rescript.plugin.lsp

Language Server 統合

com.rescript.plugin.refactor

リファクタリングサポート

com.rescript.plugin.intention

Intention Actions

com.rescript.plugin.inspection

コードインスペクション

com.rescript.plugin.util

共通ユーティリティ

関連項目