-
Improvement
-
Resolution: Unresolved
-
Normal
-
None
-
None
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
/**
|
* Function that throws exceptions
|
*
|
* @throws IOException when io is bad
|
* @returns foo
|
*/
|
void function() throws IOException { ... }
|
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.