United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
JDK-6261984 : (coll spec) *List collections doc fixes

Details
Type:
Bug
Submit Date:
2005-04-27
Status:
Resolved
Updated Date:
2012-10-08
Project Name:
JDK
Resolved Date:
2005-09-04
Component:
core-libs
OS:
generic
Sub-Component:
java.util:collections
CPU:
generic
Priority:
P3
Resolution:
Fixed
Affected Versions:
6
Fixed Versions:

Related Reports

Sub Tasks

Description
Here are some improvements for java.util.*List.java javadoc:

if list -> if the list

Gratuitous variety of semantically identical IndexOutOfBoundsException
@throws specifications.

Likewise with @throws UnsupportedOperationException

First sentence verb form.

this collection -> this list

this set -> this list

AbstractSequentialList.listIterator needs to be documented to
throw IndexOutOfBoundsException, as expected by the code,
and as implemented by the implementing classes.

More use of <tt>foo</tt> would be good.

###@###.### 2005-04-27 03:51:42 GMT

                                    

Comments
EVALUATION

A fine idea.
###@###.### 2005-04-27 03:53:02 GMT
                                     
2005-04-27



Hardware and Software, Engineered to Work Together