JDK 8 request for review: doclint fixes for some package-info files

Chris Hegarty chris.hegarty at oracle.com
Fri Jul 19 08:30:38 UTC 2013


On 07/19/2013 08:04 AM, David Holmes wrote:
> Ship it! :)

+1

-Chris.

>
> David
>
> On 19/07/2013 4:38 PM, Joe Darcy wrote:
>> Hello,
>>
>> A few more doclint issues, this time in package-info.java files, will be
>> resolved by the patch below.
>>
>> Thanks,
>>
>> -Joe
>>
>>   /*
>> - * Copyright (c) 2007, 2011, Oracle and/or its affiliates. All rights
>> reserved.
>> + * Copyright (c) 2007, 2013, Oracle and/or its affiliates. All rights
>> reserved.
>>    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>>    *
>>    * This code is free software; you can redistribute it and/or modify it
>> @@ -27,7 +27,7 @@
>>    * Interfaces and classes providing access to file and file system
>> attributes.
>>    *
>>    * <blockquote><table cellspacing=1 cellpadding=0 summary="Attribute
>> views">
>> - * <tr><th><p align="left">Attribute views</p></th><th><p
>> align="left">Description</p></th></tr>
>> + * <tr><th align="left">Attribute views</th><th
>> align="left">Description</th></tr>
>>    * <tr><td valign=top><tt><i>{@link
>> java.nio.file.attribute.AttributeView}</i></tt></td>
>>    *     <td>Can read or update non-opaque values associated with
>> objects in a file system</td></tr>
>>    * <tr><td valign=top><tt>  <i>{@link
>> java.nio.file.attribute.FileAttributeView}</i></tt></td>
>> @@ -38,7 +38,7 @@
>>    *     <td>Can read or update POSIX defined file attributes</td></tr>
>>    * <tr><td
>> valign=top><tt>      <i>{@link
>> java.nio.file.attribute.DosFileAttributeView}  </i></tt></td>
>>    *     <td>Can read or update FAT file attributes</td></tr>
>> - * <tr><td valign=top><tt>   &nbsp<i>{@link
>> java.nio.file.attribute.FileOwnerAttributeView}  </i></tt></td>
>> + * <tr><td valign=top><tt>    <i>{@link
>> java.nio.file.attribute.FileOwnerAttributeView}  </i></tt></td>
>>    *     <td>Can read or update the owner of a file</td></tr>
>>    * <tr><td valign=top><tt>     <i>{@link
>> java.nio.file.attribute.AclFileAttributeView}  </i></tt></td>
>>    *     <td>Can read or update Access Control Lists</td></tr>
>> @@ -86,14 +86,14 @@
>>    *
>>    * <ul>
>>    *
>> - *   <p><li> The {@link java.nio.file.attribute.UserPrincipal} and
>> + *   <li> The {@link java.nio.file.attribute.UserPrincipal} and
>>    *   {@link java.nio.file.attribute.GroupPrincipal} interfaces
>> represent an
>>    *   identity or group identity. </li>
>>    *
>> - *   <p><li> The {@link
>> java.nio.file.attribute.UserPrincipalLookupService}
>> + *   <li> The {@link java.nio.file.attribute.UserPrincipalLookupService}
>>    *   interface defines methods to lookup user or group principals.
>> </li>
>>    *
>> - *   <p><li> The {@link java.nio.file.attribute.FileAttribute} interface
>> + *   <li> The {@link java.nio.file.attribute.FileAttribute} interface
>>    *   represents the value of an attribute for cases where the
>> attribute value is
>>    *   required to be set atomically when creating an object in the file
>> system. </li>
>>    *
>> diff -r 2323b973adaa
>> src/share/classes/java/util/function/package-info.java
>> --- a/src/share/classes/java/util/function/package-info.java    Thu Jul
>> 18 23:16:52 2013 -0700
>> +++ b/src/share/classes/java/util/function/package-info.java    Thu Jul
>> 18 23:37:48 2013 -0700
>> @@ -1,5 +1,5 @@
>>   /*
>> - * Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights
>> reserved.
>> + * Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights
>> reserved.
>>    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>>    *
>>    * This code is free software; you can redistribute it and/or modify it
>> @@ -30,13 +30,13 @@
>>    * adapted.  Functional interfaces can provide a target type in
>> multiple contexts,
>>    * such as assignment context, method invocation, or cast context:
>>    *
>> - * <pre>
>> - *     Predicate<String> p = String::isEmpty;
>> + * <pre>{@code
>> + *     Predicate<String> p = String::isEmpty;
>>    *
>>    *     stream.filter(e -> e.getSize() > 10)...
>>    *
>>    *     stream.map((ToIntFunction) e -> e.getSize())...
>> - * </pre>
>> + * }</pre>
>>    *
>>    * <p>The interfaces in this package are functional interfaces used by
>> the JDK,
>>    * and are available to be used by user code as well.  While they do
>> not identify
>>



More information about the core-libs-dev mailing list