[OpenJDK 2D-Dev] [2d dev] [8] Review request for JDK-8028272 : Tidy warnings cleanup for javax.print package

[Yuri Nesterenko]

Hi Joe,

there seems to be several reasons:

-- in some cases this <p> just adds an extra line between items in
successive <ul> construction. Remove the <p>, and these <li>s will
stay as close to each other as regular lines in the document.
Which means too close, or did mean for original author of the doc.
See for instance
build/$CONF/docs/api/javax/print/Doc.html, <ul> started with
" Determine the format, or "doc flavor" " line.
In this case <br> does keep visual formatting almost intact, and
at the same time doesn't introduce block element in <li>.

-- again, in cases like
build/$CONF/docs/api/javax/print/package-summary.html
(which is made of src/share/classes/javax/print/attribute/package.html)
at the very end, this <p> adds an extra line, in this case
before <b>Since:</b>. Here, <br> retains visual formatting and keeps
watchdogs like doclint and tidy happy.

Sergey B. in a separate message suggests to close <p> by </p>:
that should work, too, at least in some cases.
For me, however, it seems not better and not worse than <br>
(read, more review work for all of us for nothing:-).

Thanks,
-yan

On 11/21/2013 04:46 AM, Joe Darcy wrote:
> Hello,
>
> I'm not an HTML expert, but it seems preferable to me to just remove an
> unnecessary "<p>" tag rather than replacing it with "<br/>".
>
> Is there a reason to prefer "<br/>"?
>
> Otherwise the changes look fine.
>
> Thanks,
>
> -Joe
>
> On 11/20/2013 1:47 AM, Sergey Lugovoy wrote:
>> Hi all,
>> please review the fix.
>> bug: https://bugs.openjdk.java.net/browse/JDK-8028272
>> webrev : http://cr.openjdk.java.net/~yan/8028272/webrev.00/
>>
>> This patch cleanup tidy warnings for generated html documentation for
>> javax.print package, and do not affect the appearance of the
>> documentation.
>> The patch is created against jdk8/tl team repository according to
>> requirements
>> of this cleanup project.
>>
>>
>> Best regards,
>> Serge V. Lugovoy
>