Merge pull request #18578 from rhamedy

snicoll · snicoll · commit 34287fd556a3 · 2019-10-15T08:33:32.000+02:00
* pr/18578: Polish "Clarify formatting recommendations for configuration property javadoc" Clarify formatting recommendations for configuration property javadoc Closes gh-18578
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
@@ -7110,6 +7110,8 @@ Make sure that configuration keys are documented by adding field javadoc for eac
 	}
 ----
 
+NOTE: You should only use simple text with `@ConfigurationProperties` field Javadoc, since they are not processed before being added to the JSON.
+
 Here are some rules we follow internally to make sure descriptions are consistent:
 
 * Do not start the description by "The" or "A".

Original file line number	Diff line number	Diff line change
`@@ -7110,6 +7110,8 @@ Make sure that configuration keys are documented by adding field javadoc for eac`
`7110`	`7110`	`}`
`7111`	`7111`	`----`
`7112`	`7112`
	`7113`	+NOTE: You should only use simple text with `@ConfigurationProperties` field Javadoc, since they are not processed before being added to the JSON.
	`7114`	`+`
`7113`	`7115`	`Here are some rules we follow internally to make sure descriptions are consistent:`
`7114`	`7116`
`7115`	`7117`	`* Do not start the description by "The" or "A".`