You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@metron.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2017/10/10 02:15:00 UTC

[jira] [Commented] (METRON-1240) address javadoc warnings in metron-platform and metron-analytics

    [ https://issues.apache.org/jira/browse/METRON-1240?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16198037#comment-16198037 ] 

ASF GitHub Bot commented on METRON-1240:
----------------------------------------

GitHub user dbist opened a pull request:

    https://github.com/apache/metron/pull/794

    METRON-1240 address javadoc warnings in metron-platform and metron-analytics	

    ## Contributor Comments
    [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-storm-kafka/src/main/java/org/apache/metron/storm/kafka/flux/SimpleStormKafkaBuilder.java:259: warning - @return tag has no arguments.
    [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-storm-kafka/src/main/java/org/apache/metron/storm/kafka/flux/SimpleStormKafkaBuilder.java:79: warning - @return tag has no arguments.
    [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-storm-kafka/src/main/java/org/apache/metron/storm/kafka/flux/SimpleStormKafkaBuilder.java:92: warning - @return tag has no arguments.
    [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-storm-kafka/src/main/java/org/apache/metron/storm/kafka/flux/SimpleStormKafkaBuilder.java:106: warning - @return tag has no arguments.
    [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-storm-kafka/src/main/java/org/apache/metron/storm/kafka/flux/SpoutConfiguration.java:113: warning - @return tag has no arguments.
    [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-storm-kafka/src/main/java/org/apache/metron/storm/kafka/flux/SpoutConfiguration.java:130: warning - @return tag has no arguments.
    [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-statistics/src/main/java/org/apache/metron/statistics/OnlineStatisticsProvider.java:191: warning - @return tag has no arguments.
    [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-statistics/src/main/java/org/apache/metron/statistics/OnlineStatisticsProvider.java:208: warning - @return tag has no arguments.
    [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-statistics/src/main/java/org/apache/metron/statistics/OnlineStatisticsProvider.java:224: warning - @return tag has no arguments.
    [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-statistics/src/main/java/org/apache/metron/statistics/StatisticsProvider.java:53: warning - @return tag has no arguments.
    [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-writer/src/main/java/org/apache/metron/writer/bolt/BulkMessageWriterBolt.java:105: warning - @return tag has no arguments.
    [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-writer/src/main/java/org/apache/metron/writer/bolt/BulkMessageWriterBolt.java:135: warning - @return tag has no arguments.
    [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-hbase/src/main/java/org/apache/metron/hbase/bolt/mapper/HBaseProjectionCriteria.java:70: warning - @return tag has no arguments.
    [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-hbase/src/main/java/org/apache/metron/hbase/bolt/mapper/HBaseProjectionCriteria.java:80: 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?
    - [ ] 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-1240

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/metron/pull/794.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 #794
    
----
commit a70ff96f6a3b993d353e1e9cf47882c0c89b1013
Author: Artem Ervits <ge...@gmail.com>
Date:   2017-10-10T02:13:01Z

    METRON-1240

----


> address javadoc warnings in metron-platform and metron-analytics
> ----------------------------------------------------------------
>
>                 Key: METRON-1240
>                 URL: https://issues.apache.org/jira/browse/METRON-1240
>             Project: Metron
>          Issue Type: Bug
>    Affects Versions: 0.4.1
>         Environment: mvn: 3.5.0
> jdk: 1.8.0_144
>            Reporter: Artem Ervits
>            Assignee: Artem Ervits
>            Priority: Minor
>
> at build time, getting warnings below
> {noformat}
> [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-storm-kafka/src/main/java/org/apache/metron/storm/kafka/flux/SimpleStormKafkaBuilder.java:259: warning - @return tag has no arguments.
> [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-storm-kafka/src/main/java/org/apache/metron/storm/kafka/flux/SimpleStormKafkaBuilder.java:79: warning - @return tag has no arguments.
> [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-storm-kafka/src/main/java/org/apache/metron/storm/kafka/flux/SimpleStormKafkaBuilder.java:92: warning - @return tag has no arguments.
> [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-storm-kafka/src/main/java/org/apache/metron/storm/kafka/flux/SimpleStormKafkaBuilder.java:106: warning - @return tag has no arguments.
> [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-storm-kafka/src/main/java/org/apache/metron/storm/kafka/flux/SpoutConfiguration.java:113: warning - @return tag has no arguments.
> [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-storm-kafka/src/main/java/org/apache/metron/storm/kafka/flux/SpoutConfiguration.java:130: warning - @return tag has no arguments.
> [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-statistics/src/main/java/org/apache/metron/statistics/OnlineStatisticsProvider.java:191: warning - @return tag has no arguments.
> [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-statistics/src/main/java/org/apache/metron/statistics/OnlineStatisticsProvider.java:208: warning - @return tag has no arguments.
> [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-statistics/src/main/java/org/apache/metron/statistics/OnlineStatisticsProvider.java:224: warning - @return tag has no arguments.
> [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-analytics/metron-statistics/src/main/java/org/apache/metron/statistics/StatisticsProvider.java:53: warning - @return tag has no arguments.
> [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-writer/src/main/java/org/apache/metron/writer/bolt/BulkMessageWriterBolt.java:105: warning - @return tag has no arguments.
> [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-writer/src/main/java/org/apache/metron/writer/bolt/BulkMessageWriterBolt.java:135: warning - @return tag has no arguments.
> [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-hbase/src/main/java/org/apache/metron/hbase/bolt/mapper/HBaseProjectionCriteria.java:70: warning - @return tag has no arguments.
> [WARNING] /Users/aervits/NetBeansProjects/METRON/metron/metron-platform/metron-hbase/src/main/java/org/apache/metron/hbase/bolt/mapper/HBaseProjectionCriteria.java:80: warning - @return tag has no arguments.
> {noformat}



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)