METRON-1237 address javadoc warnings in metron-maas-common #792

dbist · 2017-10-07T14:32:59Z

Contributor Comments

address javadoc warnings in metron-maas-common
[WARNING] Javadoc Warnings
[WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/Endpoint.java:57: warning - @return tag has no arguments.
[WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/MaaSConfig.java:41: warning - @return tag has no arguments.
[WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/MaaSConfig.java:55: warning - @return tag has no arguments.
[WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/ModelRequest.java:36: warning - @return tag has no arguments.
[WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/ModelRequest.java:48: warning - @return tag has no arguments.
[WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/ModelRequest.java:60: warning - @return tag has no arguments.
[WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/ModelRequest.java:72: warning - @return tag has no arguments.
[WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/ModelRequest.java:84: warning - @return tag has no arguments.
[WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/ModelRequest.java:96: warning - @return tag has no arguments.
[WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/discovery/ServiceDiscoverer.java:121: warning - @return tag has no arguments.
[WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/discovery/ServiceDiscoverer.java:224: warning - @return tag has no arguments.
[WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/discovery/ServiceDiscoverer.java:286: warning - @return tag has no arguments.
[WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/discovery/ServiceDiscoverer.java:295: warning - @return tag has no arguments.
[WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/discovery/ServiceDiscoverer.java:334: warning - @return tag has no arguments.
[WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/queue/QueueHandler.java:47: warning - @return tag has no arguments.

Pull Request Checklist

Thank you for submitting a contribution to Apache Metron.
Please refer to our Development Guidelines for the complete guide to follow for contributions.
Please refer also to our Build Verification Guidelines 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:

Is there a JIRA ticket associated with this PR? If not one needs to be created at Metron Jira.
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.
Has your PR been rebased against the latest commit within the target branch (typically master)?

For code changes:

Have you included steps to reproduce the behavior or problem that is being changed or addressed?
Have you included steps or a guide to how the change may be verified and tested manually?
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 && build_utils/verify_licenses.sh 
```
Have you written or updated unit tests and or integration tests to verify your changes?
If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
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:

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 is set up for your personal repository such that your branches are built there before submitting a pull request.

mmiklavc · 2017-10-09T16:56:24Z

Might it be better to leave off the @return altogether where the methods are self-describing?

dbist · 2017-10-09T17:40:14Z

@mmiklavc my understanding is that if we leave off @return tag, javadoc will still throw a warning about a missing return tag, please advise, I'm impartial.

mmiklavc · 2017-10-09T19:14:28Z

Ah, you are correct, e.g.

[WARNING] /Users/mmiklavcic/devprojects/metron/metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/queue/QueueHandler.java:46: warning: no @return
[WARNING] public Queue<ModelRequest> create(Map<String, Object> config) {
[WARNING] ^

mmiklavc

Thanks for the fixes @dbist. Just a few minor tweaks to the return descriptions and I'm +1 on this.

mmiklavc · 2017-10-09T19:18:49Z

...ics/metron-maas-common/src/main/java/org/apache/metron/maas/discovery/ServiceDiscoverer.java

@@ -219,7 +214,7 @@ public void unregisterByContainer(String containerIdRaw) {
   * Retrieve the endpoints for a given model.  A model may or may not have a version associated with it.
   * If the version is missing, then all endpoints are returned associated with that model name.
   * @param model
-   * @return
+   * @return state


endpoints would probably be more descriptive

mmiklavc · 2017-10-09T19:20:33Z

...ics/metron-maas-common/src/main/java/org/apache/metron/maas/discovery/ServiceDiscoverer.java

@@ -329,7 +324,7 @@ public ModelEndpoint getEndpoint(Model model) {
   * List all endpoints for a given model.
   *
   * @param model
-   * @return
+   * @return ret


Can you make this more descriptive? e.g. Mapping of models to a respective list of endpoints.

mmiklavc · 2017-10-09T19:21:03Z

...on-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/queue/QueueHandler.java

@@ -42,7 +42,7 @@
  /**
   * Create a queue handler of the specific type
   * @param config
-   * @return
+   * @return queueCreator


This would be a queue, not a creator.

mmiklavc · 2017-10-09T19:21:52Z

metron-analytics/metron-maas-common/src/main/java/org/apache/metron/maas/config/MaaSConfig.java

@@ -50,7 +50,7 @@ public void setServiceRoot(String serviceRoot) {
  /**
   * Get the distributed queue implementation handler.  By default, we use a queue in zookeeper
   * as implemented by Apache Curator.
-   * @return
+   * @return queue


queue handler

mmiklavc · 2017-10-09T21:43:50Z

+1

METRON-1237

90cb549

mmiklavc suggested changes Oct 9, 2017

View reviewed changes

address PR comments

243663c

mmiklavc mentioned this pull request Oct 9, 2017

METRON-1230: As a stopgap prior to METRON-777, add more simplistic sideloading of custom Parsers #785

Closed

10 tasks

asfgit closed this in 4c908b9 Oct 16, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

METRON-1237 address javadoc warnings in metron-maas-common #792

METRON-1237 address javadoc warnings in metron-maas-common #792

dbist commented Oct 7, 2017

mmiklavc commented Oct 9, 2017

dbist commented Oct 9, 2017

mmiklavc commented Oct 9, 2017

mmiklavc left a comment

mmiklavc Oct 9, 2017

mmiklavc Oct 9, 2017

mmiklavc Oct 9, 2017

mmiklavc Oct 9, 2017

mmiklavc commented Oct 9, 2017

METRON-1237 address javadoc warnings in metron-maas-common #792

METRON-1237 address javadoc warnings in metron-maas-common #792

Conversation

dbist commented Oct 7, 2017

Contributor Comments

Pull Request Checklist

For all changes:

For code changes:

For documentation related changes:

Note:

mmiklavc commented Oct 9, 2017

dbist commented Oct 9, 2017

mmiklavc commented Oct 9, 2017

mmiklavc left a comment

Choose a reason for hiding this comment

mmiklavc Oct 9, 2017

Choose a reason for hiding this comment

mmiklavc Oct 9, 2017

Choose a reason for hiding this comment

mmiklavc Oct 9, 2017

Choose a reason for hiding this comment

mmiklavc Oct 9, 2017

Choose a reason for hiding this comment

mmiklavc commented Oct 9, 2017