You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@metron.apache.org by dbist <gi...@git.apache.org> on 2017/10/07 14:33:04 UTC
[GitHub] metron pull request #792: METRON-1237 address javadoc warnings in metron-maa...
GitHub user dbist opened a pull request:
https://github.com/apache/metron/pull/792
METRON-1237 address javadoc warnings in metron-maas-common
## 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](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 && 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](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] 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](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/dbist/metron METRON-1237
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/792.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 #792
----
commit 90cb549cbeabaf0cd0bcbda1ee743921f3ed3f7d
Author: Artem Ervits <ge...@gmail.com>
Date: 2017-10-07T14:30:51Z
METRON-1237
----
---
[GitHub] metron pull request #792: METRON-1237 address javadoc warnings in metron-maa...
Posted by mmiklavc <gi...@git.apache.org>.
Github user mmiklavc commented on a diff in the pull request:
https://github.com/apache/metron/pull/792#discussion_r143554825
--- Diff: metron-analytics/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
--- End diff --
endpoints would probably be more descriptive
---
[GitHub] metron pull request #792: METRON-1237 address javadoc warnings in metron-maa...
Posted by mmiklavc <gi...@git.apache.org>.
Github user mmiklavc commented on a diff in the pull request:
https://github.com/apache/metron/pull/792#discussion_r143555521
--- Diff: 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
--- End diff --
queue handler
---
[GitHub] metron pull request #792: METRON-1237 address javadoc warnings in metron-maa...
Posted by mmiklavc <gi...@git.apache.org>.
Github user mmiklavc commented on a diff in the pull request:
https://github.com/apache/metron/pull/792#discussion_r143555348
--- Diff: metron-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
--- End diff --
This would be a queue, not a creator.
---
[GitHub] metron issue #792: METRON-1237 address javadoc warnings in metron-maas-commo...
Posted by dbist <gi...@git.apache.org>.
Github user dbist commented on the issue:
https://github.com/apache/metron/pull/792
@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.
---
[GitHub] metron pull request #792: METRON-1237 address javadoc warnings in metron-maa...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/metron/pull/792
---
[GitHub] metron pull request #792: METRON-1237 address javadoc warnings in metron-maa...
Posted by mmiklavc <gi...@git.apache.org>.
Github user mmiklavc commented on a diff in the pull request:
https://github.com/apache/metron/pull/792#discussion_r143555210
--- Diff: metron-analytics/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
--- End diff --
Can you make this more descriptive? e.g. Mapping of models to a respective list of endpoints.
---
[GitHub] metron issue #792: METRON-1237 address javadoc warnings in metron-maas-commo...
Posted by mmiklavc <gi...@git.apache.org>.
Github user mmiklavc commented on the issue:
https://github.com/apache/metron/pull/792
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] ^
```
---
[GitHub] metron issue #792: METRON-1237 address javadoc warnings in metron-maas-commo...
Posted by mmiklavc <gi...@git.apache.org>.
Github user mmiklavc commented on the issue:
https://github.com/apache/metron/pull/792
+1
---
[GitHub] metron issue #792: METRON-1237 address javadoc warnings in metron-maas-commo...
Posted by mmiklavc <gi...@git.apache.org>.
Github user mmiklavc commented on the issue:
https://github.com/apache/metron/pull/792
Might it be better to leave off the @return altogether where the methods are self-describing?
---