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

Javadoc method summary breaks when {@inheritDoc} from an empty parent

    XMLWordPrintable

    Details

    • Subcomponent:
    • Introduced In Version:
    • Resolved In Build:
      b24
    • CPU:
      generic
    • OS:
      generic
    • Verification:
      Verified

      Description

      ADDITIONAL SYSTEM INFORMATION :
      Tested on Windows 10, but the javadoc tool should be system-agnositic.

      A DESCRIPTION OF THE PROBLEM :
      Javadoc tool omits the last column to generate for method summary when a method {@inheritDoc} from a parent method without extra documentation.

      When there is extra text, the problem seems to be gone; however, if there is no extra text but extra custom tags (I discovered this in an enviroment with custom taglets), the issue still exists.

      This does not happen with Java 15.0.1, but happens with 16 and 17 ea (build) 21.

      REGRESSION : Last worked in version 11.0.11

      STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
      Create Test.java and Daug.java with code supplied, and run "javadoc *" in the directory containing both files. Inspect the Daug.html file.

      EXPECTED VERSUS ACTUAL BEHAVIOR :
      EXPECTED -
      The description column of Daug.act() should exist and be empty.
      ACTUAL -
      https://i.imgur.com/eepnG9x.png

      The last-col of the summary for Daug.act() method is removed and the formatting of the table messed up

      ---------- BEGIN SOURCE ----------
      public class Test {
      public void act() {}
      public void bark() {}
      }

      public class Daug extends Test {
      /**
      * {@inheritDoc}
      */
      @Override public void act() {}
      public void bite() {}
      }
      ---------- END SOURCE ----------

      FREQUENCY : always


        Attachments

        1. Daug.java
          0.1 kB
        2. Test.java
          0.1 kB
        3. screenshot.png
          screenshot.png
          19 kB

          Issue Links

            Activity

              People

              Assignee:
              hannesw Hannes Wallnoefer
              Reporter:
              webbuggrp Webbug Group
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: