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

Change doc*-Arguments in Annotations to simple Multi-Line-Strings #49

Open
mathze opened this issue May 29, 2022 · 0 comments
Open

Change doc*-Arguments in Annotations to simple Multi-Line-Strings #49

mathze opened this issue May 29, 2022 · 0 comments
Labels
enhancement New feature or request in: core The issue is related to the core library in: spring The issue is related to the spring library
Milestone

Comments

@mathze
Copy link
Contributor

mathze commented May 29, 2022

Is your feature request related to a problem? Please describe.

Kotlin offers multi-line-string (aka Raw-String) support from the beginning but Java does not for a long time.
There for the documentation related Annotation arguments where designed to support multi-line strings by allowing to use Arrays of strings. Time passed and Java now (since Java 13 as feature preview; since java 15 official standard) also supports multi-line-strings (aka. Text Blocks). Therefor there is no need to any longer support string-arrays.

Describe the solution you'd like

@Keywords' docSummary and docDetails arguments should be merge to a doc argument of type String,
@KwdArgs doc argument should be converted to simple type String.

Pro's and Con's
👍 Save arguments
👍 Give more control over documentation to the user.
👍 Code becomes simpler.
👍 Using the string-array approach, forced us to use [] in kotlin. Which would become obsolete.
👎 Breaking change!

Additional context

To mitigate the effects to already existing libraries using the current way we should try to support both ways for a short time.

@mathze mathze added enhancement New feature or request in: core The issue is related to the core library in: spring The issue is related to the spring library labels May 29, 2022
@mathze mathze added this to the 1.0.0 milestone May 29, 2022
@mathze mathze changed the title Cleanup doc-Arguments in Annotations Change doc*-Arguments in Annotations to simple Multi-Line-Strings May 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request in: core The issue is related to the core library in: spring The issue is related to the spring library
Projects
None yet
Development

No branches or pull requests

1 participant