[METRON-725] Javadoc is broken by the use of apiNote

• Type: Bug
• Status: Done
• Priority: Minor
• Resolution: Done
• Fix Version/s: 0.3.1
• Assignee: Justin Leet
• Reporter: Justin Leet
• Created: 20/Feb/17 05:07
• Updated: 28/Feb/17 12:51
• Resolved: 21/Feb/17 16:17

Description

Error seen:

>mvn javadoc:javadoc
...
[ERROR] /Users/jleet/Documents/workspace/incubator-metron/metron-platform/metron-common/src/main/java/org/apache/metron/common/utils/file/ReaderSpliterator.java:127: error: unknown tag: apiNote
...

@apiNote doesn't work by default when generating Javadocs. Apparently, it's intended to be language level information rather than a widely adopted tag.

This only shows up in ReaderSpliterator, in docs copied directly from the language construct. Given that all these methods are @Override, it seems reasonable to just drop the docs entirely, given that they inherit anyway.

If desired, we could explicitly inherit the parent docs.

Finally, we could enable the use of @apiNote, but given the intended usage and our copied use, I'm inclined to just change our code directly.

Issue Links

• links to: GitHub Pull Request #458