Project

Profile

Help

Bug #3881

closed

Javadoc for lower bounded wildcard generic type

Added by Debbie Lockett over 5 years ago. Updated over 5 years ago.

Status:
Closed
Priority:
Low
Category:
Documentation
Sprint/Milestone:
-
Start date:
2018-08-21
Due date:
% Done:

100%

Estimated time:
Legacy ID:
Applies to branch:
9.8, trunk
Fix Committed on Branch:
9.8, trunk
Fixed in Maintenance Release:
Platforms:

Description

The Saxon documentation viewer app javadoc currently does not handle Java lower bounded wildcard generic types properly (e.g. <? super A>). For example, see the constructor and getNodeWrappingFunction method for NodeWrappingAxisIterator (http://www.saxonica.com/documentation/index.html#!javadoc/net.sf.saxon.tree.iter/NodeWrappingAxisIterator). The signature for the getNodeWrappingFunction method says

"public NodeWrappingFunction< B, NodeInfo> getNodeWrappingFunction ()"

but it should be

"public NodeWrappingFunction<? super B,NodeInfo> getNodeWrappingFunction()"

as in the HTML javadoc.

The problem was discovered while working on the javadoc for 9.9, where these generics are used more widely. It appears that in 9.8, the only place they are used is in NodeWrappingAxisIterator, so it's not surprising that the problem was missed up to now.

Actions #1

Updated by Debbie Lockett over 5 years ago

Fix in f:showMethodType in viewer app stylesheet jdc-body.xsl, to use type/@preamble if it is present.

Note that preamble attributes are added by the (server side) chunk-javadoc.xsl stylesheet (which is used to process jeldoclet-out.xml), when the type/@fulltype contains a space (such as "? super B"). In this case type/@fulltype in the input is split into type/@preamble and a new type/@fulltype in the output.

Patch committed in userdoc on 9.8 and 9.9 branches.

Actions #2

Updated by Debbie Lockett over 5 years ago

  • Status changed from New to Resolved
  • Fix Committed on Branch 9.8, trunk added

Online 9.8 documentation viewer app stylesheet jdc-body.xsl updated.

Actions #3

Updated by O'Neil Delpratt over 5 years ago

  • % Done changed from 0 to 100
  • Fixed in Maintenance Release 9.9.0.1 added

Bug fix applied in the Saxon 9.9.0.1 major release.

Leave open until fix applied in the next Saxon 9.8 maintenance release.

Actions #4

Updated by Debbie Lockett over 5 years ago

  • Status changed from Resolved to Closed

Closing as the fix has already been made for the online 9.8 documentation (as a documentation fix, it is not tied to a maintenance release).

Please register to edit this issue

Also available in: Atom PDF