Project

Profile

Help

Bug #4258

Checking for broken tag links in javadoc

Added by Debbie Lockett 2 months ago. Updated 12 days ago.

Status:
Closed
Priority:
Normal
Category:
Documentation
Sprint/Milestone:
-
Start date:
2019-07-18
Due date:
% Done:

100%

Legacy ID:
Applies to branch:
9.9, trunk
Fix Committed on Branch:
9.9, trunk
Fixed in Maintenance Release:

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)}

History

#1 Updated by Debbie Lockett 2 months 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 attributefound='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).

#2 Updated by Debbie Lockett 2 months 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.

#3 Updated by Debbie Lockett 2 months 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).

#4 Updated by Debbie Lockett 15 days ago

  • Status changed from In Progress to Resolved
  • Fix Committed on Branch 9.9, trunk added

#5 Updated by O'Neil Delpratt 12 days 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

Also available in: Atom PDF