Commit 34287fd5 authored by Stephane Nicoll's avatar Stephane Nicoll

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
parents f6d5f777 f05d7902
...@@ -7110,6 +7110,8 @@ Make sure that configuration keys are documented by adding field javadoc for eac ...@@ -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: Here are some rules we follow internally to make sure descriptions are consistent:
* Do not start the description by "The" or "A". * Do not start the description by "The" or "A".
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment