-
Notifications
You must be signed in to change notification settings - Fork 620
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
@MustBeDocumented
for @Serializable
#2056
Labels
Comments
Thanks for the detailed write up! |
sandwwraith
added a commit
that referenced
this issue
Oct 12, 2022
Only annotations that affect code generation/add declarations on class-level were selected Other annotations that affect mainly properties (SerialName,Required,Transient) are left for further consideration. File-level annotations like `@UseSerializers` likely shouldn't be documented. See #2056
sandwwraith
added a commit
that referenced
this issue
Oct 13, 2022
Only annotations that affect code generation/add declarations on class-level were selected Other annotations that affect mainly properties (SerialName,Required,Transient) are left for further consideration. File-level annotations like `@UseSerializers` likely shouldn't be documented. See #2056
I'll close this for now because it is fixed in #2059. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
What is your use-case and why do you need this feature?
#2048 promotes typealiases for use with
@Serializable
.We already use it in our library and it works as expected:
However when using Dokka, the output looks like this:
This might be confusing for users of our library as it doesn't seem to make any sense to use this typealias. The important information that a custom serializer is added with this annotation is missing.
Describe the solution you'd like
To support this,
annotation class Serializable
would simply have to be annotated with theMustBeDocumented
meta-annotation:The Dokka output then looks like we would like to:
Other effects of this solution that should be considered
@Serializable
can be used in other places too:Other annotations that might be worth documenting
Maybe
@MustBeDocumented
could also be added to some other annotations, I'm thinking of@SerialName
,@Required
and@Transient
.The text was updated successfully, but these errors were encountered: