[NIFI-2698] HiveWriter checkstyle violation in Javadoc

• Type: Bug
• Status: Resolved
• Priority: Trivial
• Resolution: Cannot Reproduce
• Affects Version/s: 1.0.0
• Fix Version/s: 1.1.0
• Component/s: Documentation & Website
• Labels: beginner checkstyle
• Assignee: Andy LoPresto
• Reporter: Andy LoPresto
• Created: 29/Aug/16 17:53
• Updated: 18/Oct/16 23:57
• Resolved: 18/Oct/16 23:57

Description

There is a checkstyle violation in HiveWriter.java – in the Javadoc, a static inner class is referenced but the class information cannot be loaded.

[INFO] --- maven-checkstyle-plugin:2.15:check (default-cli) @ nifi-hive-processors ---
[WARNING] src/main/java/org/apache/nifi/util/hive/HiveWriter.java[102:20] (javadoc) JavadocMethod: Unable to get class information for @throws tag 'WriteFailure'.
...
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:2.15:check (default-cli) on project nifi-hive-processors: You have 1 Checkstyle violation. -> [Help 1]

There are instructions to suppress this error type by modifying checkstyle.xml [1].

<module name="RedundantThrows">
    <property name="suppressLoadErrors" value="true"/>
</module>

[1] http://stackoverflow.com/a/35733030/70465