You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@daffodil.apache.org by "Steve Lawrence (JIRA)" <ji...@apache.org> on 2018/09/13 13:56:00 UTC
[jira] [Commented] (DAFFODIL-1380) Update genjavadoc plugin to 10
when released and enable doclint
[ https://issues.apache.org/jira/browse/DAFFODIL-1380?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16613533#comment-16613533 ]
Steve Lawrence commented on DAFFODIL-1380:
------------------------------------------
During scala 2.12 support and dependency updates, the genjavadoc was also updated to version 0.11, fixing the @throws issue mentioned in this bug.
All that remains in this bug is to remove the -Xdoclint option to enable extra javadoc checks, and potentially fix any issues that are found with the generated javadoc.
> Update genjavadoc plugin to 10 when released and enable doclint
> ---------------------------------------------------------------
>
> Key: DAFFODIL-1380
> URL: https://issues.apache.org/jira/browse/DAFFODIL-1380
> Project: Daffodil
> Issue Type: Improvement
> Components: API, Infrastructure
> Reporter: Steve Lawrence
> Priority: Major
> Labels: beginner
> Fix For: deferred
>
>
> The Java 8 javadoc tool has a feature called -Xdoclint, which performs extra checks on the javadoc. One of these checks is to ensure that any @throws tags in the javadoc have a corresponding throws clause in Java. For example{code:language=java}
> /**
> * Function that throws exceptions
> *
> * @throws IOException when io is bad
> * @returns foo
> */
> void function() throws IOException { ... }
> {code}
> However, version 9 of the genjavadoc plugin did not generate the throws clause for the scala @throws attribute. So, the generated java code failed the doclint checks. To get around this, doclint was turned off in commit 124151db82add3f2494f32818c29755d64b98f3c of DFDL-1367.
> Version 10 of the plugin will have support for generating the throws clause from scala @throws annotations. When that is released we should update to that and enable the doclint javadoc feature.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)