[jira] [Updated] (METRON-725) Javadoc is broken by the use of apiNote

["Justin Leet (JIRA)" <ji...@apache.org>]

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

Justin Leet updated METRON-725:
-------------------------------
    Fix Version/s: 0.3.1

> Javadoc is broken by the use of apiNote
> ---------------------------------------
>
>                 Key: METRON-725
>                 URL: https://issues.apache.org/jira/browse/METRON-725
>             Project: Metron
>          Issue Type: Bug
>            Reporter: Justin Leet
>            Assignee: Justin Leet
>            Priority: Minor
>             Fix For: 0.3.1
>
>
> Error seen:
> {code}
> >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
> ...
> {code}
> {{@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.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)