RFR: JDK-8223356: Bad placement of marker comment in module-summary.html
Hannes Wallnöfer
hannesw at openjdk.java.net
Thu Oct 14 15:07:51 UTC 2021
On Thu, 14 Oct 2021 14:08:32 GMT, Pavel Rappo <prappo at openjdk.org> wrote:
> I wonder if this change will negatively affect some downstream tools. Also, the proposed position of the "MODULE DESCRIPTION" is inconsistent with that of other markers, such as "PACKAGE DESCRIPTION". Doesn't "PACKAGE DESCRIPTION" have a similar problem?
It's true that placement of marker comments is inconsistent, and there are other places where the marker follows the `section` element or is missing. Maybe the best thing is to retract this pull request (as well as openjdk/jdk#5947) and have a more thorough look.
As for breaking tools relying on the exact placement of these markers: That's possible and would be unfortunate, but if we can fix a problem with the output I think we should still do so.
-------------
PR: https://git.openjdk.java.net/jdk/pull/5946
More information about the javadoc-dev
mailing list