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

Block tags in overview.html are ignored

XMLWordPrintable

    • 9
    • b11
    • generic
    • generic

      ADDITIONAL SYSTEM INFORMATION :
      Fedora 33 / java version "15.0.2" 2021-01-19

      Also does not work with latest Java-11

      A DESCRIPTION OF THE PROBLEM :
      Block tags in an overview file (such as "-overview overview.html") are not rendered.

      REGRESSION : Last worked in version 8u281

      STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
      Create a small project with at least two packages and an overview.html. Write some text in overview.html and at the end add e.g. '@see "Somwhere else"'. Run javadoc.

      EXPECTED VERSUS ACTUAL BEHAVIOR :
      EXPECTED -
      Index.html should contain the information from the overview including a "See also" section.
      ACTUAL -
      The @see tag (and other block tags are dropped.



      ---------- BEGIN SOURCE ----------
      I cannot insert the complete project tree here.
      ---------- END SOURCE ----------

      CUSTOMER SUBMITTED WORKAROUND :
      None.

      The problem "starts" at jdk.javadoc.internal.doclets.formats.html.AbstractPackageIndexWriter.buildPackageIndexFile(String title, boolean includeScript) where (only) addOverviewComment ist called. While this might still add everything, it only adds the "fullBody".

      FREQUENCY : always


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

              Created:
              Updated:
              Resolved: