GitHub user justinleet opened a pull request:
https://github.com/apache/incubator-metron/pull/458
METRON-725: Javadoc is broken by the use of apiNote
As noted in the ticket, there are 3 options for fixing this
1. Just delete the offending inherited javadoc
2. Explicitly inherit the Javadoc
3. Enable the `@apiNote` tag
This PR just does the first one, but it's easy to change if anybody has a
strong preference. I lean pretty heavily towards 1 or 2 (because 3 is
apparently more intended towards the Java language, rather than outside usage)
To test, just run mvn javadoc:javadoc.
This also suggests that we should be running this as part of our normal
build process (and I'll create a ticket if people agree).
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/justinleet/incubator-metron javadoc_fixes
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-metron/pull/458.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #458
----
commit 1e1dbbd71da13570767c7025f0aed8b0b801205a
Author: justinjleet <justinjl...@gmail.com>
Date: 2017-02-20T05:06:51Z
Removing already inherited Javadoc
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
