Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-5003030

(ref spec) ref classes may require commentary on generic params in method signat

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Open
    • Priority: P4
    • Resolution: Unresolved
    • Affects Version/s: 5.0
    • Fix Version/s: None
    • Component/s: core-libs
    • Labels:
    • Subcomponent:
    • Understanding:
      Fix Understood
    • CPU:
      generic
    • OS:
      solaris_8, solaris_9

      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

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              mr Mark Reinhold
              Reporter:
              ilittlesunw Ian Little (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

                Dates

                Created:
                Updated:
                Imported:
                Indexed: