Asciidoctor warnings due to javadoc conversion

[philwebb]

> Task :spring-boot-project:spring-boot-docs:asciidoctorPdf
Failed to parse formatted text: Whether to disable the escaping of HTML characters such as '<', '>', etc.
Failed to parse formatted text: Whether to disable the escaping of HTML characters such as '<', '>', etc.
Failed to parse formatted text: JNDI location of the datasource. Class, url, username & password are ignored when set.
Failed to parse formatted text: JNDI location of the datasource. Class, url, username & password are ignored when set.
Failed to parse formatted text: Comma-separated list of additional unencoded characters that should be allowed in URI paths. Only "< > [ \ ] ^ ` { | }" are allowed.
Failed to parse formatted text: Comma-separated list of additional unencoded characters that should be allowed in URI query strings. Only "< > [ \ ] ^ ` { | }" are allowed.
Failed to parse formatted text: Comma-separated list of additional unencoded characters that should be allowed in URI paths. Only "< > [ \ ] ^ ` { | }" are allowed.
Failed to parse formatted text: Comma-separated list of additional unencoded characters that should be allowed in URI query strings. Only "< > [ \ ] ^ ` { | }" are allowed.

I think this is due to our use if < and > in some of the configuration properties javadoc. We might want to escape those then update the converter code to deal with them. We'll also need to update the annotation processor that generates JSON.

[snicoll]

We'll also need to update the annotation processor that generates JSON.

I don't think these needs escaping as it's part of the description that's already a String.

[philwebb]

What I meant was we have comments like this in ServerProperties:

/**
 * Comma-separated list of additional unencoded characters that should be allowed
 * in URI paths. Only "< > [ \ ] ^ ` { | }" are allowed.
 */

Those cause javadoc warnings because < should be written as <. We've generally tried to avoid javadoc specific markup in the configuration properties but I think these are different.

If we replaced those chars, I don't know what the impact would be on the JSON generation.

[wilkinsona]

They're Asciidoctor warnings rather than javadoc warnings, aren't they? I think those above are from Asciidoctor's PDF generation. There aren't any warnings from the HTML generation, but it sounds like it might be bad too.

[philwebb]

I thought I'd seen IDE errors as well, but now I'm not so sure.

[dreis2211]

With the asciidoctor gradle plugin on version 3.0.0 this starts to actually fail. I've opened #19953 that addresses the upgrade and attempts to fix the issues above.

[wilkinsona]

Superseded by #19953.