Please Review javadoc cleanup 8026516

roger riggs roger.riggs at oracle.com
Wed Oct 16 21:01:54 UTC 2013


Hi Lance,

The immediate issue was to get javadoc -Xlint  clean again.
AFAIK that is what has been requested.

Roger

On 10/16/2013 4:56 PM, Lance Andersen - Oracle wrote:
> Hi Roger
> On Oct 16, 2013, at 4:50 PM, roger riggs wrote:
>
>> Hi Lance,
>>
>> The empty <p> tag is because in most cases it precedes a <ul> or a 
>> header <hx> .
>> So there is no content in the paragraph.
>
> I was referring more to an example such as this in Instant.java
>
> * <h3>Time-scale</h3>
>   * <p>
>   * The length of the solar day is the standard way that humans measure time.
>   * This has traditionally been subdivided into 24 hours of 60 minutes of 60 seconds,
>   * forming a 86400 second day.
>   * <p>
>
> I believe this is no longer correct with the current html standards. 
>  tidy complained to me when I ran against one my my doclint reported 
> javadocs for tags like that that I did not fix (and a slew of other 
> errors which I am
> going to let go for now).
>
> Just trying to know if it is just enough to address what doclint is 
> complaining about or should I go further?
>
>
> Best
> Lance
>>
>> In the past using an empty <p> tag created some empty vertical space;
>> but i understand that's a misuse of <p>.
>> I didn't try to compensate for that in my updates but it does change 
>> the appearance since
>> the vertical space gone.  I'll have to look to see if there is some 
>> spacing control for <ul>
>> that would restore the spacing.
>>
>> Roger
>>
>> On 10/16/2013 4:37 PM, Lance Andersen - Oracle wrote:
>>> Hi Roger,
>>>
>>> I think what you have done is OK.
>>>
>>> I do have questions on should more be done in general so that we use <P> </P> (as I thought that was no required vs just a solo <P>?).   As I started to look through some of the JDBC warnings,  I saw more tags that I thought should have been reported by doclint as there were no closing </P>.  I see similar scenarios in for example Instant.java
>>>
>>> Trying to figure out how much we really need to do
>>>
>>> Best
>>> Lance
>>> On Oct 16, 2013, at 4:15 PM, roger riggs wrote:
>>>
>>>> Hi,
>>>>
>>>> Javadoc cleanup to satisfy javadoc -Xlint.
>>>>
>>>> Webrev:
>>>>    http://cr.openjdk.java.net/~rriggs/webrev-javadoc-8026516/
>>>>
>>>> Thanks, Roger
>>>>
>>>
>>>
>>> Lance Andersen| Principal Member of Technical Staff | +1.781.442.2037
>>> Oracle Java Engineering
>>> 1 Network Drive
>>> Burlington, MA 01803
>>> Lance.Andersen at oracle.com
>>>
>>
>
> <http://oracle.com/us/design/oracle-email-sig-198324.gif>
> <http://oracle.com/us/design/oracle-email-sig-198324.gif>Lance 
> Andersen| Principal Member of Technical Staff | +1.781.442.2037
> Oracle Java Engineering
> 1 Network Drive
> Burlington, MA 01803
> Lance.Andersen at oracle.com <mailto:Lance.Andersen at oracle.com>
>




More information about the core-libs-dev mailing list