Bug #3988
closed
Javadoc: include "since" and "deprecated" info from respective comment tags
Fix Committed on Branch:
9.9
Fixed in Maintenance Release:
Description
Info from the @since and @deprecated tags is shown in the HTML Java API documentation, but not in the documentation app.
- Status changed from New to In Progress
In fact the documentation app javadoc does sometimes show "Since" info originating from @since tags; but apparently only for methods. This should be extended for any members (including the class, interfaces, etc. themselves; and any members of these: fields, etc.)
The info from @since and @deprecated tags in javadoc comments is captured by the jeldoclet and included in the javadoc XML files within the relevant <comment> element as <attribute name="@since"> and <attribute name="@deprecated"> children respectively. These <attribute> elements have <body><div> content.
As in the HTML javadoc, in summary tables/sections, if the member is marked as deprecated, it would be best to use the @deprecated content rather than the summary (from comment/sentence). In the details sections, the @deprecated content should prepend the summary.
Documentation app stylesheet updates committed on 9.9 branch (xsl/jdc-body.xsl, jdp-body.xsl, and viewer_app.sef.xml).
- Status changed from In Progress to Closed
- Fix Committed on Branch 9.9 added
9.9. documentation app SEF updated online.
Please register to edit this issue
Also available in: Atom
PDF
.