JDK-6293091 : REGRESSION: Inheriting comments from J2SE does NOT work.
  • Type: Bug
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 5.0
  • Priority: P3
  • Status: Closed
  • Resolution: Duplicate
  • OS: windows_xp
  • CPU: x86
  • Submitted: 2005-06-30
  • Updated: 2007-10-16
  • Resolved: 2005-07-19
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
JDK 6
6Resolved
Related Reports
Duplicate :  
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

Comments
EVALUATION It's likely that this is a duplicate of 6289776: javadoc should retrieve inherited data from source files even when newer class files found Could the submitter please check whether touching the source files being inherited (like Comparable.java) -- so they're timestamped later than the corresponding classes in rt.jar -- eliminates the problem? ###@###.### 2005-07-01 01:01:18 GMT Hi Scott, Yes you are correct. After I update the time stamp(did a touch as you suggested) on Comparable.java, javadoc could inherit the comments. Thanks, ###@###.### ###@###.### 2005-07-19 01:32:13 GMT
01-07-2005