Merge pull request #18578 from rhamedy

* pr/18578:
  Polish "Clarify formatting recommendations for configuration property javadoc"
  Clarify formatting recommendations for configuration property javadoc

Closes gh-18578
pull/18566/head
Stephane Nicoll 5 years ago
commit 34287fd556

@ -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".

Loading…
Cancel
Save