Bug #3987
closedJavadoc for generic methods
100%
Description
In the documentation app javadoc, generic methods (i.e. methods parameterized by one or more type parameters) are not currently handled correctly. The type parameters are not shown.
e.g. net.sf.saxon.Configuration.setConfigurationProperty, declared as public <T> void setConfigurationProperty(Feature<T> feature, T value)
but the javadoc page in the documentation app does not show the type parameters.
Note that the HTML javadoc is ok.
Updated by Debbie Lockett over 5 years ago
- Status changed from New to In Progress
Fix required in the jeldoclet to capture information for type parameters for generic methods, in the GenericHandler.addMethodParams method.
In the javadoc XML files (and jeldoclet-out.xml), generic methods then have a <paramtype>
element with <type>
children, providing type information for each type parameter.
Patch committed to the jeldoclet.jar (and Java source) in lib.
Updated by Debbie Lockett over 5 years ago
- Description updated (diff)
- Applies to branch 9.8 added
As well as ensuring the javadoc XML files contain the relevant information about type parameters, the documentation app stylesheets need to be updated to use this information (and show the type parameters in the method signature, etc.) i.e. changes are required in jdc-body.xsl.
Relatedly, further changes have also been made in jdc-body.xsl to tidy up the way that type parameters are displayed for generic classes, interfaces, etc.
Additionally, the function f:class-parts
in jdc-body.xsl has been updated, so that enums are declared correctly i.e. to say "public enum" (as in the HTML javadoc) rather than "public final class".
There was little use of generic methods before 9.9 (I can only find 5 in 9.8), and not many generic classes, interfaces, etc. But for completeness I've decided to apply the patches for xsl/jdc-body.xsl for the 9.8 documentation app too.
Updated by Debbie Lockett over 5 years ago
Patches for xsl/jdc-body.xsl committed on 9.9 and 9.8.
This stylesheet (and the SEF for the 9.9 documentation app) and the generated javadoc XML files will be updated online with the next maintenance releases.
Updated by Debbie Lockett over 5 years ago
- Status changed from In Progress to Closed
- % Done changed from 0 to 100
- Fix Committed on Branch 9.8, 9.9 added
- Fixed in Maintenance Release 9.8.0.15, 9.9.0.2 added
Documentation bug fixes applied with the Saxon 9.9.0.2 and 9.8.0.15 maintenance releases.
Please register to edit this issue