Le 28/09/2016 à 15:06, Gilles a écrit :

> I use Java 8 and did not get any errors when generating the apidocs.
> 
> Unless I'm missing something, the above message does not correspond
> to the change in this commit.
> 
> The changes themselves contradict usage of the <p> HTML tag: <p> and
> </p> enclose a paragraph, not a headline.
> 
> So I think that this change should be reverted.
> 
> Then please let us know what problems you encountered so we can
> decide _together_ on how we want Javadoc to be written for this
> component (and possibly others).

Do we really need to decide together how to fix trivial Javadoc issues?
I wanted to regenerate the Javadoc and I got several errors when running
"mvn javadoc:javadoc" on Windows 7 with Java 8u91 and Maven 3.3.9. <ul>
and <code> enclosed in <p> caused the issue (this is not allowed by the
HTML specification [1]). So I simply changed:

<p>blah blah:
<ul>
  <li>Blah</li>
</ul>
</p>

into the visually equivalent:

<p>blah blah:</p>
<ul>
  <li>Blah</li>
</ul>

You didn't see the errors because -Xdoclint:none is enabled for the site
phase.

Emmanuel Bourg

[1] https://www.w3.org/TR/html5/grouping-content.html#the-p-element


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to