Bug #4258
closed
Checking for broken tag links in javadoc
100%
Description
Following on from work investigating forum topic 7505 (https://saxonica.plan.io/boards/3/topics/7505), it would be good to be able to check that the links generated from {@link} markup in javadoc comments will work.
As noted in the forum topic, an example of a link which does not work can be found on the net.sf.saxon.lib.OutputURIResolver page: {@link net.sf.saxon.s9api.Xslt30Transformer#setResultDocumentHandler(Function)}
Updated by Debbie Lockett almost 5 years ago
- Status changed from New to In Progress
I have created a stylesheet jd-build/check-tag-links.xsl to check tag elements in javadoc-xml/packages/ files against javadoc-types.xml. This should be run after regenerating the content of javadoc-xml (product-xsljavadoc build task), and the output should be analysed to check for highlighted issues (i.e. look for tag elements with attribute found='no'`).
Currently the stylesheet only checks non-local links (i.e. ones which contain '.').
Stylesheet committed on 9.9 and 10.0 branches (build99 and build100).
Updated by Debbie Lockett almost 5 years ago
Committed changes to Java source on 9.9 and 10.0 branches, to fix some problematic links as highlighted using the check-tag-links.xsl stylesheet.
Updated by Debbie Lockett almost 5 years ago
Committed in build99 and build100: add run of tag link checker stylesheet (check-tag-links.xsl) to jd-build as part of product-xsljavadoc target; also updated stylesheet to produce diagnostic messages to highlight issues (as well as in the tag-check.xml output document).
Updated by Debbie Lockett over 4 years ago
- Status changed from In Progress to Resolved
- Fix Committed on Branch 9.9, trunk added
Updated by O'Neil Delpratt over 4 years ago
- Status changed from Resolved to Closed
- % Done changed from 0 to 100
- Fixed in Maintenance Release 9.9.1.5 added
Bug fix applied in the Saxon 9.9.1.5 maintenance release.
Please register to edit this issue
.