Spring-boot: Document formatting recommendations for configuration property javadoc

Created on 14 Oct 2019  路  5Comments  路  Source: spring-projects/spring-boot

The configuration-processor removes all new lines from JavaDoc but this can cause troubles when one is using an HTML <pre> tag in its JavaDoc.

superseded documentation
Source
picture jjoslet

All 5 comments

This is working as designed as there's no support for formatting of the configuration property descriptions. We should probably make this clearer in the documentation by mentioning it in this section.

wilkinsona picture wilkinsona on 14 Oct 2019
👍1

I agree adding a note there is a good idea. For the record, there is already a note in the documentation

snicoll picture snicoll on 14 Oct 2019
👍1

@wilkinsona @snicoll can I make a PR for this?

rhamedy picture rhamedy on 14 Oct 2019

@rhamedy A PR would be most welcome. Thanks.

philwebb picture philwebb on 14 Oct 2019
👍1

Closing in favour of PR #18578

snicoll picture snicoll on 15 Oct 2019
Was this page helpful?
0 / 5 - 0 ratings

Related issues

lievendoclo picture lievendoclo  路  3Comments
shahid21st picture shahid21st  路  3Comments
mkgit007 picture mkgit007  路  3Comments
alimate picture alimate  路  3Comments
bbrouwer picture bbrouwer  路  3Comments