[DAFFODIL-1380] Update genjavadoc plugin to 10 when released and enable doclint

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 2.4.0
• Component/s: API, Infrastructure
• Labels: beginner
• Assignee: Mark C. Otto
• Reporter: Steve Lawrence
• Created: 22/Jun/15 15:05
• Updated: 20/May/21 20:01
• Resolved: 21/Feb/19 23:06

Description

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.