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

stddoclet: @param in base class is ignored if {@inheritDoc} in main description



      Name: gm110360 Date: 11/13/2002


      FULL PRODUCT VERSION :
      C:\Java>java -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 : Windows ME


      A DESCRIPTION OF THE PROBLEM :
      @param tag in the sub class is ignored.

      STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
      1. Try to generate a javadoc with the sample above
      2.
      3.

      EXPECTED VERSUS ACTUAL BEHAVIOR :
      @param tag in the sub class should be reflected in a
      generated HTML file. But @para tag in the base class is
      copied into the generated HTML files.

      REPRODUCIBILITY :
      This bug can be reproduced always.

      ---------- BEGIN SOURCE ----------
      abstract class InheritDocBase {
          /**
           * Return the last name of persons whose first name is matched.
           *
           * @param firstName firstName to be searched
           * @return array of last names
           * @throws java.lang.Exception name not found
           */
           public abstract String[] geLastName(String firstName) throws Exception;
      }


      class InheritDocSub extends InheritDocBase {
          /**
           * Based on the address book, {@inheritDoc}
           *
           * @param firstName first Name to be searched from the address book.
           */
           public abstract String[] geLastName(String firstName) throws Exception;
      }
      ---------- END SOURCE ----------
      (Review ID: 166857)
      ======================================================================

      Name: rmT116609 Date: 02/27/2003


      DESCRIPTION OF THE PROBLEM :
      Using {@inheritDoc} in a method comment overrides the @param
      tag.

      The {@inheritDoc} should only add text, not override any,
      and it shouldn't affect tags that don't contain it.

      STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
      1. javadoc SuperClass.java SubClass.java

      EXPECTED VERSUS ACTUAL BEHAVIOR :
      SubClass METHOD DETAIL contents:

      expected:
      Parameters:
      bar - subclass doc bar

      actual:
      Parameters:
      bar - superclass doc bar

      REPRODUCIBILITY :
      This bug can be reproduced always.

      ---------- BEGIN SOURCE ----------
      public class SuperClass {
              /**
               * First sentence from superclass. Second sentence from superclass.
               * @param bar superclass doc bar
               */
              public void foo( int bar ) {}
      }

      public class SubClass extends SuperClass {
              /**
               * {@inheritDoc} First sentence from subclass. Second sentence from
      subclass.
               * @param bar subclass doc bar
               */
              public void foo( int bar ) {}
      }

      ---------- END SOURCE ----------


      (Review ID: 181838)
      ======================================================================

            bpatel Bhavesh Patel (Inactive)
            gmanwanisunw Girish Manwani (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: