RFR: 8029451 : Tidy warnings cleanup for java.util package

Martin Buchholz martinrb at google.com
Fri Dec 6 17:20:53 UTC 2013 

FYI: When I run javadoc on jsr166 CVS (it's not too hard for y'all to do
this as well), I still see many warnings inherited from openjdk8 source:

 $ ant docs
...
  [javadoc] Constructing Javadoc information...
  [javadoc] Standard Doclet version 1.8.0-ea
  [javadoc] Building tree for all the packages and classes...
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/ArrayList.java:759:
warning: no @param for s
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/ArrayList.java:759:
warning: no @throws for java.io.IOException
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/ArrayList.java:759:
warning: no @throws for java.lang.ClassNotFoundException
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/ArrayList.java:736:
warning: no @param for s
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/ArrayList.java:736:
warning: no @throws for java.io.IOException
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/BitSet.java:1140:
warning: no @param for s
  [javadoc]     private void readObject(ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/BitSet.java:1140:
warning: no @throws for java.io.IOException
  [javadoc]     private void readObject(ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/BitSet.java:1140:
warning: no @throws for java.lang.ClassNotFoundException
  [javadoc]     private void readObject(ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/BitSet.java:1123:
warning: no @param for s
  [javadoc]     private void writeObject(ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/BitSet.java:1123:
warning: no @throws for java.io.IOException
  [javadoc]     private void writeObject(ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Calendar.java:3509:
warning: no @param for stream
  [javadoc]     private void readObject(ObjectInputStream stream)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Calendar.java:3509:
warning: no @throws for java.io.IOException
  [javadoc]     private void readObject(ObjectInputStream stream)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Calendar.java:3509:
warning: no @throws for java.lang.ClassNotFoundException
  [javadoc]     private void readObject(ObjectInputStream stream)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Calendar.java:3455:
warning: no @param for stream
  [javadoc]     private synchronized void writeObject(ObjectOutputStream
stream)
  [javadoc]                               ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Calendar.java:3455:
warning: no @throws for java.io.IOException
  [javadoc]     private synchronized void writeObject(ObjectOutputStream
stream)
  [javadoc]                               ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Collections.java:2536:
warning: no @return
  [javadoc]         private Object readResolve() {
  [javadoc]                        ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Collections.java:2573:
warning: no @return
  [javadoc]         private Object writeReplace() {
  [javadoc]                        ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Collections.java:1441:
warning: no @return
  [javadoc]         private Object readResolve() {
  [javadoc]                        ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Collections.java:1471:
warning: no @return
  [javadoc]         private Object writeReplace() {
  [javadoc]                        ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Currency.java:595:
warning: no @return
  [javadoc]     private Object readResolve() {
  [javadoc]                    ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Date.java:1329:
warning: no @param for s
  [javadoc]     private void readObject(ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Date.java:1329:
warning: no @throws for java.io.IOException
  [javadoc]     private void readObject(ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Date.java:1329:
warning: no @throws for java.lang.ClassNotFoundException
  [javadoc]     private void readObject(ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Date.java:1320:
warning: no @param for s
  [javadoc]     private void writeObject(ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Date.java:1320:
warning: no @throws for java.io.IOException
  [javadoc]     private void writeObject(ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/EnumMap.java:791:
warning: no @param for s
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/EnumMap.java:791:
warning: no @throws for java.io.IOException
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/EnumMap.java:791:
warning: no @throws for java.lang.ClassNotFoundException
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/EnumMap.java:766:
warning: no @param for s
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/EnumMap.java:766:
warning: no @throws for java.io.IOException
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/GregorianCalendar.java:3235:
warning: no @param for stream
  [javadoc]     private void readObject(ObjectInputStream stream)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/GregorianCalendar.java:3235:
warning: no @throws for java.io.IOException
  [javadoc]     private void readObject(ObjectInputStream stream)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/GregorianCalendar.java:3235:
warning: no @throws for java.lang.ClassNotFoundException
  [javadoc]     private void readObject(ObjectInputStream stream)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/HashMap.java:1359:
warning: no @param for s
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/HashMap.java:1359:
warning: no @throws for java.io.IOException
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/HashMap.java:1359:
warning: no @throws for java.lang.ClassNotFoundException
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/HashMap.java:1345:
warning: no @param for s
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/HashMap.java:1345:
warning: no @throws for java.io.IOException
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/HashSet.java:294:
warning: no @param for s
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/HashSet.java:294:
warning: no @throws for java.io.IOException
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/HashSet.java:294:
warning: no @throws for java.lang.ClassNotFoundException
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/HashSet.java:273:
warning: no @param for s
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/HashSet.java:273:
warning: no @throws for java.io.IOException
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Hashtable.java:1165:
warning: no @param for s
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Hashtable.java:1165:
warning: no @throws for java.io.IOException
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Hashtable.java:1165:
warning: no @throws for java.lang.ClassNotFoundException
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Hashtable.java:1130:
warning: no @param for s
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Hashtable.java:1130:
warning: no @throws for java.io.IOException
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/IdentityHashMap.java:1301:
warning: no @param for s
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/IdentityHashMap.java:1301:
warning: no @throws for java.io.IOException
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/IdentityHashMap.java:1301:
warning: no @throws for java.lang.ClassNotFoundException
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/IdentityHashMap.java:1278:
warning: no @param for s
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/IdentityHashMap.java:1278:
warning: no @throws for java.io.IOException
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/LinkedList.java:1139:
warning: no @param for s
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/LinkedList.java:1139:
warning: no @throws for java.io.IOException
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/LinkedList.java:1139:
warning: no @throws for java.lang.ClassNotFoundException
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/LinkedList.java:1121:
warning: no @param for s
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/LinkedList.java:1121:
warning: no @throws for java.io.IOException
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Locale.java:2169:
warning: no description for @throws
  [javadoc]      * @throws IOException
  [javadoc]        ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Locale.java:2170:
warning: no description for @throws
  [javadoc]      * @throws ClassNotFoundException
  [javadoc]        ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Locale.java:2171:
warning: no description for @throws
  [javadoc]      * @throws IllformedLocaleException
  [javadoc]        ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Locale.java:2152:
warning: no description for @throws
  [javadoc]      * @throws IOException
  [javadoc]        ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Locale.java:2207:
warning: no description for @throws
  [javadoc]      * @throws java.io.ObjectStreamException
  [javadoc]        ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/PropertyPermission.java:618:
warning: no @param for out
  [javadoc]     private void writeObject(ObjectOutputStream out) throws
IOException {
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/PropertyPermission.java:618:
warning: no @throws for java.io.IOException
  [javadoc]     private void writeObject(ObjectOutputStream out) throws
IOException {
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Random.java:1181:
warning: no @param for s
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Random.java:1181:
warning: no @throws for java.io.IOException
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Random.java:1181:
warning: no @throws for java.lang.ClassNotFoundException
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Random.java:1200:
warning: no @param for s
  [javadoc]     synchronized private void writeObject(ObjectOutputStream s)
  [javadoc]                               ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Random.java:1200:
warning: no @throws for java.io.IOException
  [javadoc]     synchronized private void writeObject(ObjectOutputStream s)
  [javadoc]                               ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/SimpleTimeZone.java:1669:
warning: no @param for stream
  [javadoc]     private void readObject(ObjectInputStream stream)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/SimpleTimeZone.java:1669:
warning: no @throws for java.io.IOException
  [javadoc]     private void readObject(ObjectInputStream stream)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/SimpleTimeZone.java:1669:
warning: no @throws for java.lang.ClassNotFoundException
  [javadoc]     private void readObject(ObjectInputStream stream)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/SimpleTimeZone.java:1639:
warning: no @param for stream
  [javadoc]     private void writeObject(ObjectOutputStream stream)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/SimpleTimeZone.java:1639:
warning: no @throws for java.io.IOException
  [javadoc]     private void writeObject(ObjectOutputStream stream)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/TreeMap.java:2441:
warning: no @param for s
  [javadoc]     private void readObject(final java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/TreeMap.java:2441:
warning: no @throws for java.io.IOException
  [javadoc]     private void readObject(final java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/TreeMap.java:2441:
warning: no @throws for java.lang.ClassNotFoundException
  [javadoc]     private void readObject(final java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/TreeMap.java:2421:
warning: no @param for s
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/TreeMap.java:2421:
warning: no @throws for java.io.IOException
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/TreeSet.java:517:
warning: no @param for s
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/TreeSet.java:517:
warning: no @throws for java.io.IOException
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/TreeSet.java:517:
warning: no @throws for java.lang.ClassNotFoundException
  [javadoc]     private void readObject(java.io.ObjectInputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/TreeSet.java:497:
warning: no @param for s
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/TreeSet.java:497:
warning: no @throws for java.io.IOException
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Vector.java:1067:
warning: no @param for s
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^
  [javadoc]
/home/martin/jdk/src/jdk8/jdk/src/share/classes/java/util/Vector.java:1067:
warning: no @throws for java.io.IOException
  [javadoc]     private void writeObject(java.io.ObjectOutputStream s)
  [javadoc]                  ^



On Fri, Dec 6, 2013 at 7:44 AM, Michael McMahon <
michael.x.mcmahon at oracle.com> wrote:

> On 06/12/13 11:44, Alan Bateman wrote:
>
>> On 05/12/2013 05:30, Sergey Lugovoy wrote:
>>
>>> Hi all,
>>> please review the fix
>>> http://cr.openjdk.java.net/~yan/8029451/webrev.01/
>>> for
>>> https://bugs.openjdk.java.net/browse/JDK-8029451
>>>
>>> This patch cleanup tidy warnings for generated html documentation, and do
>>> not affect the appearance of the documentation.
>>>
>>>  In java/util/zip/package.html then I see that the <p> tags have been
>> replaced by <br/>. Is that okay in HTML 3.2? I just wonder if it might be
>> better to just remove the <p> tags. I don't see a problem with changing the
>> spacing of the list items.
>>
>> -Alan
>>
>
> I just noticed some broken link fragments in the java.util.stream package.
> Would it be worthwhile including the fix in this change, or should I file
> a separate bug?
>
> Michael
>

More information about the core-libs-dev mailing list