From 1f9b68707ff441e7744758de52318e7c197b60bf Mon Sep 17 00:00:00 2001 From: Rafiullah Hamedy Date: Mon, 14 Oct 2019 13:28:52 -0400 Subject: [PATCH] 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 --- .../src/main/asciidoc/spring-boot-features.adoc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc index 8d98cd4be4b..2b469da026b 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc @@ -7118,6 +7118,9 @@ Here are some rules we follow internally to make sure descriptions are consisten * 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". * Do not provide the default value in the description unless it has to be determined at runtime. +NOTE: You should only use simple text with `@ConfigurationProperties` field Javadoc, since +they are not processed before being added to the JSON. + Make sure to <> so that IDE assistance is available for your keys as well. You may want to review the generated metadata (`META-INF/spring-configuration-metadata.json`) to make sure your keys are properly documented. Using your own starter in a compatible IDE is also a good idea to validate that quality of the metadata.