RFR: JDK-8218998: Add metadata to generated API documentation files
Jonathan Gibbons
jonathan.gibbons at oracle.com
Fri Feb 15 20:16:30 UTC 2019
Please review a medium-small patch to add some new metadata into each
HTML document that is generated by javadoc.
The metadata provides the following:
* a short stylized description of the contents of the file, for
potential use by other tools to filter the set of generated files
* an indication of the part of javadoc that generated the file, to
help group the different kinds of pages generated by javadoc
A new test program is added. It's a bit of overkill, but it is designed
to be future-proof, meaning if we add new types of pages, this test will
(intentionally) fail until it is updated to know about those new pages.
I also note that the test was instrumental in helping to discover two
unrelated bugs in javadoc. These are linked in the "related links" in
the JBS issue.
-- Jon
JBS: https://bugs.openjdk.java.net/browse/JDK-8218998
Webrev: http://cr.openjdk.java.net/~jjg/8218998/webrev.00/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.java.net/pipermail/javadoc-dev/attachments/20190215/e1c6cd49/attachment.html>
More information about the javadoc-dev
mailing list