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

Add option to include full package description at top, before interface table

XMLWordPrintable

    • b140
    • x86
    • windows_2000
    • Verified



      Name: jk109818 Date: 03/07/2002


      FULL PRODUCT VERSION :
      java version "1.3.1_01"
      Java(TM) 2 Runtime Environment, Standard Edition (build 1.3.1_01)
      Java HotSpot(TM) Client VM (build 1.3.1_01, mixed mode)

      FULL OPERATING SYSTEM VERSION :Microsoft Windows 2000
      [Version 5.00.2195]


      A DESCRIPTION OF THE PROBLEM :
      While still keeping the functionality of including only the
      first sentence of the package description in the summary
      table on the Overview page, it would be helpful to add an
      option to put the remainder of the package description
      BEFORE the interface and class tables on the package pages.
      That way, the package pages would be consistent with the
      interface and class pages.

      The problem is that many people (such as impatient
      developers) don't seem to grasp the intent of the "See:
        Description" link on the package pages. They go to the
      page, see the single sentence, and assume that's the extent
      of the explanation (given their familiarity with how
      interface and class pages are organized).

      STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
      1. Generate API documentation
      2. Look at a package-summary file
      3.

      This bug can be reproduced always.
      (Review ID: 139877)
      ======================================================================

            bpatel Bhavesh Patel (Inactive)
            jkimsunw Jeffrey Kim (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: