google / google/ksp

Publish KSP API documentation

Open
#1,375 6 comments 0 reactions 0 assignees View on GitHub
Dominant language
Kotlin
Stars
3.5k
Forks
415
Avg merge
1d 2h
Merged PRs (30d)
53

Description

I'm trying to write a KSP plugin; and I'm looking for API docs. I can't seem to find any. I've searched the README.md and the Kotlin website.

The closest to API docs seems to be https://kotlinlang.org/docs/ksp-overview.html#how-ksp-looks-at-source-files, but that's very incomplete. There's https://kotlinlang.org/docs/ksp-reference.html#type-operations giving a mapping from Java, but it's not complete either.

I'd love to have something like the API docs we have for kotlin.collections: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/

I guess what everyone's doing is reading the code in https://github.com/google/ksp/tree/main/api/src/main/kotlin/com/google/devtools/ksp, or using IntelliJ autocompletion to navigate through the API?

Given the big value proposition of KSP is the stable API, I think it would be wonderful to document that API.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.