[
https://issues.apache.org/jira/browse/METRON-725?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15876058#comment-15876058
]
ASF GitHub Bot commented on METRON-725:
---------------------------------------
Github user cestella commented on the issue:
https://github.com/apache/incubator-metron/pull/458
Yeah, I'm ok with this fix. I shouldn't have just green-lit the inherited
javadoc suggested by the IDE.
Also, I think we probably *should* do the following during builds:
* generate javadoc
* generate the site-book
My only concern is that we already have hefty build times, but maybe that's
not a good enough reason to avoid these kinds of errors.
Anyway, +1 by inspection.
> 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
>
> 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)
