daffodil-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Michael Beckerle (JIRA)" <j...@apache.org>
Subject [jira] [Resolved] (DAFFODIL-1380) Update genjavadoc plugin to 10 when released and enable doclint
Date Thu, 21 Feb 2019 23:07:00 GMT

     [ https://issues.apache.org/jira/browse/DAFFODIL-1380?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Michael Beckerle resolved DAFFODIL-1380.
----------------------------------------
    Resolution: Fixed

Fixed git hash 937033bf99646e024def756704f171e1ad12f635

> 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
>            Assignee: Mark C. Otto
>            Priority: Major
>              Labels: beginner
>             Fix For: 2.4.0
>
>
> 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)

Mime
View raw message