[
https://issues.apache.org/jira/browse/METRON-1673?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16545493#comment-16545493
]
ASF GitHub Bot commented on METRON-1673:
----------------------------------------
GitHub user justinleet opened a pull request:
https://github.com/apache/metron/pull/1107
METRON-1673: Fix Javadoc errors
## Contributor Comments
Javadoc blew up when we run `mvn javadoc:javadoc`. Now it should complete
successfully. Although with a ton of warnings. To test just `mvn
javadoc:javadoc` from the root dir.
If we're good with the build matrix from
https://github.com/apache/metron/pull/1106, I propose we add the javadoc to the
build as part of this PR, in order to avoid this in the future.
I didn't alter `-Xdoclint:none` in the pom, because we use the multiline
string lib and it'll blow up. I'm unsure if there's a way around this.
## Pull Request Checklist
Thank you for submitting a contribution to Apache Metron.
Please refer to our [Development
Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235)
for the complete guide to follow for contributions.
Please refer also to our [Build Verification
Guidelines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview)
for complete smoke testing guides.
In order to streamline the review of the contribution we ask you follow
these guidelines and ask you to double check the following:
### For all changes:
- [x] Is there a JIRA ticket associated with this PR? If not one needs to
be created at [Metron
Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel).
- [x] Does your PR title start with METRON-XXXX where XXXX is the JIRA
number you are trying to resolve? Pay particular attention to the hyphen "-"
character.
- [x] Has your PR been rebased against the latest commit within the target
branch (typically master)?
### For code changes:
- [x] Have you included steps to reproduce the behavior or problem that is
being changed or addressed?
- [x] Have you included steps or a guide to how the change may be verified
and tested manually?
- [x] Have you ensured that the full suite of tests and checks have been
executed in the root metron folder via:
```
mvn -q clean integration-test install &&
dev-utilities/build-utils/verify_licenses.sh
```
- [x] Have you written or updated unit tests and or integration tests to
verify your changes?
- [x] If adding new dependencies to the code, are these dependencies
licensed in a way that is compatible for inclusion under [ASF
2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [x] Have you verified the basic functionality of the build by building
and running locally with Vagrant full-dev environment or the equivalent?
### For documentation related changes:
- [x] Have you ensured that format looks appropriate for the output in
which it is rendered by building and verifying the site-book? If not then run
the following commands and the verify changes via
`site-book/target/site/index.html`:
```
cd site-book
mvn site
```
#### Note:
Please ensure that once the PR is submitted, you check travis-ci for build
issues and submit an update to your PR as soon as possible.
It is also recommended that [travis-ci](https://travis-ci.org) is set up
for your personal repository such that your branches are built there before
submitting a pull request.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/justinleet/metron javadocFixing
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/1107.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 #1107
----
commit dba5984a493a8d6e11ea0e6de5a235f779aa35ee
Author: justinjleet <justinjleet@...>
Date: 2018-07-16T16:33:54Z
Javadoc error fixes
----
> Fix Javadoc errors
> ------------------
>
> Key: METRON-1673
> URL: https://issues.apache.org/jira/browse/METRON-1673
> Project: Metron
> Issue Type: Bug
> Reporter: Justin Leet
> Assignee: Justin Leet
> Priority: Major
>
> Our Javadocs have errors. They should be fixed. Ideally, building Javadoc
> should be part of the build. However, we've held off for time restraints in
> the build. [https://github.com/apache/metron/pull/1099] proposes a build
> matrix for our build, and we could slot it into one of the sub builds without
> these time constraints.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
