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

REGRESSION: Inheriting comments from J2SE does NOT work.

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: P3
    • Resolution: Duplicate
    • Affects Version/s: 5.0
    • Fix Version/s: 6
    • Component/s: tools
    • Labels:

      Description

      FULL PRODUCT VERSION :
      java version "1.5.0_04"
      Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_04-b05)
      Java HotSpot(TM) Client VM (build 1.5.0_04-b05, mixed mode, sharing)

      ADDITIONAL OS VERSION INFORMATION :
      Windows XP

      A DESCRIPTION OF THE PROBLEM :
      Failure getting inheritance of JDK comments into my own methods to
      work using JDK 1.5_02 in the way as described by the FAQ entry "Inheriting Comments from J2SE". Whatever I do, the generated JavaDoc does not contain inherited JDK source info.

      It appears to be a REGRESSION of the following bug:
      4707291: Want to inherit documentation from classes not being documented
      http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4707291

      STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
      Sample class...

      package com.package1;

      /**
       * This is class Class1.
       */
      public class Class1 implements Comparable {

          /**
           * {@inheritDoc}
           */
          public int compareTo(Object obj) {
          }
      }

      Using 1.4.2 javadoc:
      javadoc -d html -source 1.4 -sourcepath .:src com.package1

      generates the correct inherited documentation. Using 5.0 I see no inherited documetation for the compareTo() method.

      EXPECTED VERSUS ACTUAL BEHAVIOR :
      EXPECTED -
      J2SE comments for java interfaces to be inherited into documentation for my implementing classes.
      ACTUAL -
      No comments in my classes where they shoul have been inherited.

      REPRODUCIBILITY :
      This bug can be reproduced always.

      Release Regression From : 1.4.2
      The above release value was the last known release where this
      bug was known to work. Since then there has been a regression.
      ###@###.### 2005-06-30 20:46:22 GMT

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              gmanwanisunw Girish Manwani (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                Imported:
                Indexed: