Repository: metron Updated Branches: refs/heads/master 67cba8130 -> 4f7081aa7
METRON-1240 address javadoc warnings in metron-platform and metron-analytics (dbist via james-sirota) closes apache/metron#794 Project: http://git-wip-us.apache.org/repos/asf/metron/repo Commit: http://git-wip-us.apache.org/repos/asf/metron/commit/4f7081aa Tree: http://git-wip-us.apache.org/repos/asf/metron/tree/4f7081aa Diff: http://git-wip-us.apache.org/repos/asf/metron/diff/4f7081aa Branch: refs/heads/master Commit: 4f7081aa7b572b31ea66a42ba9ce96c8f8ca5c09 Parents: 67cba81 Author: dbist <[email protected]> Authored: Mon Oct 16 09:27:59 2017 -0700 Committer: jsirota <[email protected]> Committed: Mon Oct 16 09:27:59 2017 -0700 ---------------------------------------------------------------------- .../apache/metron/statistics/OnlineStatisticsProvider.java | 6 +++--- .../org/apache/metron/statistics/StatisticsProvider.java | 2 +- .../metron/hbase/bolt/mapper/HBaseProjectionCriteria.java | 4 ++-- .../metron/storm/kafka/flux/SimpleStormKafkaBuilder.java | 8 ++++---- .../org/apache/metron/writer/bolt/BulkMessageWriterBolt.java | 4 ++-- 5 files changed, 12 insertions(+), 12 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/metron/blob/4f7081aa/metron-analytics/metron-statistics/src/main/java/org/apache/metron/statistics/OnlineStatisticsProvider.java ---------------------------------------------------------------------- diff --git a/metron-analytics/metron-statistics/src/main/java/org/apache/metron/statistics/OnlineStatisticsProvider.java b/metron-analytics/metron-statistics/src/main/java/org/apache/metron/statistics/OnlineStatisticsProvider.java index 7ac83fd..1d7bdc6 100644 --- a/metron-analytics/metron-statistics/src/main/java/org/apache/metron/statistics/OnlineStatisticsProvider.java +++ b/metron-analytics/metron-statistics/src/main/java/org/apache/metron/statistics/OnlineStatisticsProvider.java @@ -185,7 +185,7 @@ public class OnlineStatisticsProvider implements StatisticsProvider, KryoSeriali /** * Unbiased kurtosis. * See http://commons.apache.org/proper/commons-math/apidocs/org/apache/commons/math4/stat/descriptive/moment/Kurtosis.html - * @return + * @return unbiased kurtosis */ @Override public double getKurtosis() { @@ -202,7 +202,7 @@ public class OnlineStatisticsProvider implements StatisticsProvider, KryoSeriali /** * Unbiased skewness. * See http://commons.apache.org/proper/commons-math/apidocs/org/apache/commons/math4/stat/descriptive/moment/Skewness.html - * @return + * @return unbiased skewness */ @Override public double getSkewness() { @@ -218,7 +218,7 @@ public class OnlineStatisticsProvider implements StatisticsProvider, KryoSeriali /** * This returns an approximate percentile based on a t-digest. * @param p - * @return + * @return an approximate percentile based on a t-digest */ @Override public double getPercentile(double p) { http://git-wip-us.apache.org/repos/asf/metron/blob/4f7081aa/metron-analytics/metron-statistics/src/main/java/org/apache/metron/statistics/StatisticsProvider.java ---------------------------------------------------------------------- diff --git a/metron-analytics/metron-statistics/src/main/java/org/apache/metron/statistics/StatisticsProvider.java b/metron-analytics/metron-statistics/src/main/java/org/apache/metron/statistics/StatisticsProvider.java index 051b3a9..860aa4e 100644 --- a/metron-analytics/metron-statistics/src/main/java/org/apache/metron/statistics/StatisticsProvider.java +++ b/metron-analytics/metron-statistics/src/main/java/org/apache/metron/statistics/StatisticsProvider.java @@ -48,7 +48,7 @@ public interface StatisticsProvider { /** * Unbiased skewness. * See http://commons.apache.org/proper/commons-math/apidocs/org/apache/commons/math4/stat/descriptive/moment/Skewness.html - * @return + * @return unbiased skewness */ double getSkewness(); http://git-wip-us.apache.org/repos/asf/metron/blob/4f7081aa/metron-platform/metron-hbase/src/main/java/org/apache/metron/hbase/bolt/mapper/HBaseProjectionCriteria.java ---------------------------------------------------------------------- diff --git a/metron-platform/metron-hbase/src/main/java/org/apache/metron/hbase/bolt/mapper/HBaseProjectionCriteria.java b/metron-platform/metron-hbase/src/main/java/org/apache/metron/hbase/bolt/mapper/HBaseProjectionCriteria.java index d3c8237..728d769 100644 --- a/metron-platform/metron-hbase/src/main/java/org/apache/metron/hbase/bolt/mapper/HBaseProjectionCriteria.java +++ b/metron-platform/metron-hbase/src/main/java/org/apache/metron/hbase/bolt/mapper/HBaseProjectionCriteria.java @@ -65,7 +65,7 @@ public class HBaseProjectionCriteria implements Serializable { /** * all columns from this family will be included as result of HBase lookup. * @param columnFamily - * @return + * @return column family along with all of its columns from an HBase lookup */ public HBaseProjectionCriteria addColumnFamily(String columnFamily) { this.columnFamilies.add(columnFamily.getBytes()); @@ -75,7 +75,7 @@ public class HBaseProjectionCriteria implements Serializable { /** * Only this column from the the columnFamily will be included as result of HBase lookup. * @param column - * @return + * @return a particular column from a column family as part of an HBase lookup */ public HBaseProjectionCriteria addColumn(ColumnMetaData column) { this.columns.add(column); http://git-wip-us.apache.org/repos/asf/metron/blob/4f7081aa/metron-platform/metron-storm-kafka/src/main/java/org/apache/metron/storm/kafka/flux/SimpleStormKafkaBuilder.java ---------------------------------------------------------------------- diff --git a/metron-platform/metron-storm-kafka/src/main/java/org/apache/metron/storm/kafka/flux/SimpleStormKafkaBuilder.java b/metron-platform/metron-storm-kafka/src/main/java/org/apache/metron/storm/kafka/flux/SimpleStormKafkaBuilder.java index 4db1302..1bcee9a 100644 --- a/metron-platform/metron-storm-kafka/src/main/java/org/apache/metron/storm/kafka/flux/SimpleStormKafkaBuilder.java +++ b/metron-platform/metron-storm-kafka/src/main/java/org/apache/metron/storm/kafka/flux/SimpleStormKafkaBuilder.java @@ -74,7 +74,7 @@ public class SimpleStormKafkaBuilder<K, V> extends KafkaSpoutConfig.Builder<K, V /** * Return a list of the enums * @param configs - * @return + * @return ret a list of enums */ public static List<FieldsConfiguration> toList(String... configs) { List<FieldsConfiguration> ret = new ArrayList<>(); @@ -87,7 +87,7 @@ public class SimpleStormKafkaBuilder<K, V> extends KafkaSpoutConfig.Builder<K, V /** * Return a list of the enums from their string representation. * @param configs - * @return + * @return ret a list of enums from string representation */ public static List<FieldsConfiguration> toList(List<String> configs) { List<FieldsConfiguration> ret = new ArrayList<>(); @@ -101,7 +101,7 @@ public class SimpleStormKafkaBuilder<K, V> extends KafkaSpoutConfig.Builder<K, V * Construct a Fields object from an iterable of enums. These fields are the fields * exposed in the Storm tuple emitted from the spout. * @param configs - * @return + * @return Fields object from enums iterable */ public static Fields getFields(Iterable<FieldsConfiguration> configs) { List<String> fields = new ArrayList<>(); @@ -254,7 +254,7 @@ public class SimpleStormKafkaBuilder<K, V> extends KafkaSpoutConfig.Builder<K, V * @param zkQuorum * @param fieldsConfiguration * @param kafkaProps The aforementioned map. - * @return + * @return StormKafkaSpout from a given topic, zk quorum and fields */ public static <K, V> StormKafkaSpout<K, V> create( String topic , String zkQuorum http://git-wip-us.apache.org/repos/asf/metron/blob/4f7081aa/metron-platform/metron-writer/src/main/java/org/apache/metron/writer/bolt/BulkMessageWriterBolt.java ---------------------------------------------------------------------- diff --git a/metron-platform/metron-writer/src/main/java/org/apache/metron/writer/bolt/BulkMessageWriterBolt.java b/metron-platform/metron-writer/src/main/java/org/apache/metron/writer/bolt/BulkMessageWriterBolt.java index 9b4a6df..8202604 100644 --- a/metron-platform/metron-writer/src/main/java/org/apache/metron/writer/bolt/BulkMessageWriterBolt.java +++ b/metron-platform/metron-writer/src/main/java/org/apache/metron/writer/bolt/BulkMessageWriterBolt.java @@ -100,7 +100,7 @@ public class BulkMessageWriterBolt extends ConfiguredIndexingBolt { * may want to take this behavior into account. * * @param batchTimeoutDivisor - * @return + * @return BulkMessageWriterBolt */ public BulkMessageWriterBolt withBatchTimeoutDivisor(int batchTimeoutDivisor) { if (batchTimeoutDivisor <= 0) { @@ -129,7 +129,7 @@ public class BulkMessageWriterBolt extends ConfiguredIndexingBolt { * This method is called by TopologyBuilder.createTopology() to obtain topology and * bolt specific configuration parameters. We use it primarily to configure how often * a tick tuple will be sent to our bolt. - * @return + * @return conf topology and bolt specific configuration parameters */ @Override public Map<String, Object> getComponentConfiguration() {
