Java Solaris Communities Sun Store Join SDN My Profile Why Join?
 
Bug Database
Bug Detail
Quick Lists
Top 25 Bugs
Top 25 RFE's
Recently Closed Bugs
Printable Page Printable Page


Bug Database
Bug ID: 4778264
Votes 0
Synopsis {@inheritDoc} does not copy from interface definition properly, hangs
Category doclet:tbd
Reported Against 1.4.1
Release Fixed
State 11-Closed, duplicate of 4720974, bug
Priority: 4-Low
Related Bugs 4720974
Submit Date 13-NOV-2002
Description




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


FULL OPERATING SYSTEM VERSION : Redhat 8.0, 2.4.18 Glibc,
glibc-2.2.93-5


A DESCRIPTION OF THE PROBLEM :
{@inheritDoc} handling does not allow you to copy javdoc
down more than once.  Rather than issue any warnings, it
simply hangs, eventually crashing with an OutOfMemoryError

STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
1. Try to generate the javadoc for the code listing below.
     javadoc -private A.java
2. javadoc will hang every time.

EXPECTED VERSUS ACTUAL BEHAVIOR :
It should work properly, and copy the javadoc down from the
nearest superclass.

ERROR MESSAGES/STACK TRACES THAT OCCUR :
No errors or warnings, eventually javadoc fails with an OutOfMemoryError.

REPRODUCIBILITY :
This bug can be reproduced always.

---------- A.java --------------
public interface A
{
        /**
         * Returns the size of this A.
         *
         * @return The size of this A.
         */
        public int size();
}

abstract class B implements A
{
        /**
         * {@inheritDoc}
         *
         * @return {@inheritDoc}
         */
        public int size()
        {
                return 0;
        }
}

class C extends B
{
        /**
         * {@inheritDoc}
         *
         * @return {@inheritDoc}
         */
        public int size()
        {
                return 1;
        }
}
---------- END A.java ----------

CUSTOMER WORKAROUND :
Don't use {@inheritDoc}, copy comments by hand.  This, like
the  first sentence calculation bug, basically makes
{@inheritDoc} useless.
(Review ID: 166856) 
======================================================================
Work Around
N/A
Evaluation
Can reproduce in 1.4.1_01, but cannot reproduce in 1.4.2.

  xxxxx@xxxxx   2002-11-13
Comments
  
  Include a link with my name & email   


PLEASE NOTE: JDK6 is formerly known as Project Mustang