JDK-5003030 : (ref spec) ref classes may require commentary on generic params in method signat
  • Type: Bug
  • Component: core-libs
  • Sub-Component: java.lang
  • Affected Version: 5.0
  • Priority: P4
  • Status: Open
  • Resolution: Unresolved
  • OS: solaris_8,solaris_9
  • CPU: generic
  • Submitted: 2004-02-25
  • Updated: 2004-04-26
Related Reports
Duplicate :  
Description
The javadocs for classes java.lang.ref.FinalReference, java.lang.ref.SoftReference,
java.lang.ref.WeakReference, java.lang.ref.PhantomReference may need some additional
comment text clarifying the parameter lists within descriptions of the constructor
params and method params.

Here is a list of the constructor and methods possibly requiring additional
commentary javadoc text. Style and approach might dictate that it is not 
necessary to provide additional comments since the method signatures might
be seen as self explanatory to the API documentation reader and the intended
target audience.


java.lang.ref.FinalReference:
public FinalReference(T referent, ReferenceQueue<? super T> q)

java.lang.ref.SoftReference:
public SoftReference(T referent)
public SoftReference(T referent, ReferenceQueue<? super T> q)
public T get()

java.lang.ref.WeakReference:
public WeakReference(T referent)
public WeakReference(T referent, ReferenceQueue<? super T> q)

java.lang.PhantomReference:
public PhantomReference(T referent ReferenceQueue<? super T> q)
###@###.### 2004-02-25

Comments
EVALUATION Yes, that's true. -- ###@###.### 2004/4/25
04-12-0191