Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Inlining KotoolsTypesVersion in API reference using KSP #596

Closed
LVMVRQUXL opened this issue Mar 20, 2024 · 1 comment
Closed

📝 Inlining KotoolsTypesVersion in API reference using KSP #596

LVMVRQUXL opened this issue Mar 20, 2024 · 1 comment
Labels
automation Automating things. documentation Improvements or additions to documentation.

Comments

@LVMVRQUXL
Copy link
Contributor

📝 Description

We would like to create an internal compiler plugin for inlining KotoolsTypesVersion in our API reference using Kotlin Symbol Processing (KSP).
For each declaration using the ExperimentalSince, the Since and the DeprecatedSince annotations, we want to generate an equivalent annotation accepting a String that should be documented instead of the explicit ones from the kotools.types.internal annotation.

Here's an example of a simple type declaration:

package kotools.types.web

import kotools.types.internal.ExperimentalSince
import kotools.types.internal.KotoolsTypesVersion

@ExperimentalSince(version = KotoolsTypesVersion.V4_4_0)
public interface EmailAddress

The goal is to generate the following code:

package kotools.types.web

@MustBeDocumented
private annotation class ExperimentalSince(val version: String)

@ExperimentalSince(version = "4.4.0")
public interface EmailAddress
@LVMVRQUXL LVMVRQUXL added documentation Improvements or additions to documentation. automation Automating things. labels Mar 20, 2024
@LVMVRQUXL
Copy link
Contributor Author

This is an idea that we will not apply to this project.

@LVMVRQUXL LVMVRQUXL closed this as not planned Won't fix, can't repro, duplicate, stale Jul 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation Automating things. documentation Improvements or additions to documentation.
Projects
None yet
Development

No branches or pull requests

1 participant