JDK-6261984 : (coll spec) *List collections doc fixes
  • Type: Bug
  • Status: Resolved
  • Resolution: Fixed
  • Component: core-libs
  • Sub-Component: java.util:collections
  • Priority: P3
  • Affected Version: 6
  • OS: generic
  • CPU: generic
  • Submit Date: 2005-04-27
  • Updated Date: 2012-10-08
  • Resolved Date: 2005-09-04
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availabitlity Release.

To download the current JDK release, click here.
JDK 6
6 b51Resolved
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