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

Uninformative Doc comment, first sentence -- ClassLoader

XMLWordPrintable

    • beta
    • generic
    • generic



      Name: dg70945 Date: 11/05/98


      The first sentence in the ClassLoader class
      DocComment which is used in the summary page for
      package java.lang is not very informative.
      (.../jdk1.2fcs/docs/api/java/lang/package-summary.html)
      It should be swapped with the second sentence.

      The first sentence (which is presently used in the
      summary) is "The class ClassLoader is an abstract
      class." The second, more informative sentence is
      "A class loader is an object that is responsible
      for loading classes."
      (Review ID: 40717)
      ======================================================================

      Name: krT82822 Date: 08/18/99


      In the java.lang package index at
      http://java.sun.com/products/jdk/1.2/docs/api/java/lang/package-summary.html,
      note how the class summary for ClassLoader says:

          The class ClassLoader is an abstract class.


      Come on! Aren't your programmers of core Java classes oriented
      regarding how to write documentation comment text so that
      JavaDoc's output is useful?
      (Review ID: 94071)
      ======================================================================

            jhosunw Jamie Ho (Inactive)
            dgreensunw Dale Green (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: