Skip to content

Commit f05d790

Browse files
committed
Polish "Clarify formatting recommendations for configuration property javadoc"
See gh-18578
1 parent 1f9b687 commit f05d790

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7110,6 +7110,8 @@ Make sure that configuration keys are documented by adding field javadoc for eac
71107110
}
71117111
----
71127112

7113+
NOTE: You should only use simple text with `@ConfigurationProperties` field Javadoc, since they are not processed before being added to the JSON.
7114+
71137115
Here are some rules we follow internally to make sure descriptions are consistent:
71147116

71157117
* Do not start the description by "The" or "A".
@@ -7118,9 +7120,6 @@ Here are some rules we follow internally to make sure descriptions are consisten
71187120
* 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".
71197121
* Do not provide the default value in the description unless it has to be determined at runtime.
71207122

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-
71247123
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.
71257124
You may want to review the generated metadata (`META-INF/spring-configuration-metadata.json`) to make sure your keys are properly documented.
71267125
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)