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.

Sign up for GitHub

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

Jump to bottom

SerialName annotation should be documented #2386

Closed
kunyavskiy opened this issue Aug 1, 2023 · 0 comments
Closed

SerialName annotation should be documented #2386

kunyavskiy opened this issue Aug 1, 2023 · 0 comments
Labels
feature

Comments

@kunyavskiy
Copy link

What is your use-case and why do you need this feature?

Generated documentation for serializable classes can be useful not only as documentation of code but also as baseline documentation of external API, which these serialized classes represent.

In that case "how this entity would be named in json" is an important part of API.

Describe the solution you'd like

Mark @SerialName and maybe some other similar annotations with @MustBeDocumented.
qwwdfsad added a commit that referenced this issue Aug 9, 2023
@qwwdfsad
Mark @SerialName, @required and @transient with @MustBeDocumented
407c17a 
Documentation for @serializable classes describes not only the class itself, but its serializable form, which might/is used as the reference for external API/REST-like documentation.

Thus, all properties that constrain or change serialized form are explicitly marked with @MBD in order to highlight that fact in the documentation

Fixes #2386
@qwwdfsad qwwdfsad mentioned this issue Aug 9, 2023
Merged
@lukellmann lukellmann mentioned this issue Aug 11, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kunyavskiy