Skip to content

Commit 1f9b687

Browse files
rhamedysnicoll
authored andcommitted
Clarify formatting recommendations for configuration property javadoc
This commit adds a note to spring-boot-features.adoc to clarify that using javadoc tags to format configuration property descriptions is not supported. See gh-18578
1 parent f6d5f77 commit 1f9b687

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7118,6 +7118,9 @@ Here are some rules we follow internally to make sure descriptions are consisten
71187118
* Use `java.time.Duration` rather than `long` and describe the default unit if it differs from milliseconds, e.g. "If a duration suffix is not specified, seconds will be used".
71197119
* Do not provide the default value in the description unless it has to be determined at runtime.
71207120

7121+
NOTE: You should only use simple text with `@ConfigurationProperties` field Javadoc, since
7122+
they are not processed before being added to the JSON.
7123+
71217124
Make sure to <<appendix-configuration-metadata#configuration-metadata-annotation-processor,trigger meta-data generation>> so that IDE assistance is available for your keys as well.
71227125
You may want to review the generated metadata (`META-INF/spring-configuration-metadata.json`) to make sure your keys are properly documented.
71237126
Using your own starter in a compatible IDE is also a good idea to validate that quality of the metadata.

0 commit comments

Comments
 (0)