JDK-8264274 : Block tags in overview.html are ignored
  • Type: Bug
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 11,14,15
  • Priority: P3
  • Status: Resolved
  • Resolution: Fixed
  • OS: generic
  • CPU: generic
  • Submitted: 2021-03-24
  • Updated: 2021-08-17
  • Resolved: 2021-08-17
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 18
18 masterFixed
Description
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



Comments
Changeset: 0e3fde6c Author: Hannes Wallnöfer <hannesw@openjdk.org> Date: 2021-08-17 08:29:49 +0000 URL: https://git.openjdk.java.net/jdk/commit/0e3fde6c3c2f5c05777b79ff5eb1188014269b0f
17-08-2021

Complete project is not required. A simple test case is required for reproducing the issue. Requested submitter to provide a minimal test case.
26-03-2021

The issue can be reproduced using javadoc -d generated --source-path testfiles -subpackages test -overview testfiles/overview.html The "See also" section gets missed in the generated overview-summary.html This is a regression as: JDK 8u281 : Pass JDK 11 : Fail JDK 14 : Fail JDK 15 : Fail JDK 16: Fail
26-03-2021