[
https://issues.apache.org/jira/browse/DERBY-7038?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16839022#comment-16839022
]
Rick Hillegas commented on DERBY-7038:
--------------------------------------
Attaching derby-7038-02-aa-use-ant-javadoc-task.diff. This patch reverts the
build to using the <javadoc> task to build javadoc rather than the <exec> task.
This is now possible because ant 1.10.6 supports several module-aware javadoc
switches.
The old and new javadoc outputs (for public api and for internal Derby classes)
is slightly different. Mostly, the new output is more informative. However,
there are cases where the old output is more informative. I don't know what
causes the discrepancies. In any event, the differences do not look significant
to me, either way.
Regardless of which output one prefers, it seems to me that if we wanted to
invest more effort in the javadoc, a more critical improvement would be to
systematically add package summaries to the overview page for each module. Some
packages have summary lines but most don't.
Touches the following file:
{noformat}
-------------------------------------
M build.xml
Replaces <exec> tasks with <javadoc> tasks.
{noformat}
> Upgrade ant version and re-write javadoc build targets to use improved
> <javadoc>task
> ------------------------------------------------------------------------------------
>
> Key: DERBY-7038
> URL: https://issues.apache.org/jira/browse/DERBY-7038
> Project: Derby
> Issue Type: Improvement
> Components: Build tools
> Affects Versions: 10.16.0.0
> Reporter: Rick Hillegas
> Assignee: Rick Hillegas
> Priority: Major
> Attachments: derby-7038-01-aa-require-Ant-1.10.6.diff,
> derby-7038-02-aa-use-ant-javadoc-task.diff
>
>
> Version 1.10.6 of ant will enhance the <javadoc> task in order to understand
> some of the module-aware switches introduced by Java 9. Currently, our
> javadoc targets work around the limitations of the <javadoc> task by running
> javadoc via the <java> task. We should upgrade our version of ant and
> re-write the javadoc targets to take advantage of the improvements introduced
> by ant 1.10.16 (see
> https://dist.apache.org/repos/dist/dev/ant/RELEASE-NOTES-1.10.6.html). I
> imagine this work will occur in 3 phases:
> 1) Upgrade the Jenkins scripts to require ant 1.10.6.
> 2) Upgrade our build scripts to require ant 1.10.6.
> 3) Re-wire our javadoc targets.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
