This is an automated email from the ASF dual-hosted git repository.
cwylie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-druid.git
The following commit(s) were added to refs/heads/master by this push:
new 5f08b0b Add checkstyle for "Prohibit @author tags in Javadoc" (#7682)
5f08b0b is described below
commit 5f08b0b474a9d811f2a3b419d72fd3c6df157c9e
Author: Merlin Lee <[email protected]>
AuthorDate: Mon May 20 15:09:51 2019 +0800
Add checkstyle for "Prohibit @author tags in Javadoc" (#7682)
* Add checkstyle for "Prohibit @author tags in Javadoc"
* Add "Do not use author tags/information in the code" back to
CONTRIBUTING.md
---
codestyle/checkstyle.xml | 9 +++++++++
.../main/java/org/apache/druid/java/util/common/io/Closer.java | 1 -
.../druid/examples/twitter/TwitterSpritzerFirehoseFactory.java | 2 --
.../java/org/apache/druid/extendedset/intset/AbstractIntSet.java | 1 -
.../java/org/apache/druid/extendedset/intset/ConciseSet.java | 4 ----
.../main/java/org/apache/druid/extendedset/intset/IntSet.java | 1 -
.../druid/storage/cassandra/CassandraDataSegmentConfig.java | 2 --
.../druid/storage/cassandra/CassandraDataSegmentPusher.java | 2 --
.../aggregation/datasketches/hll/HllSketchAggregatorFactory.java | 1 -
.../aggregation/datasketches/hll/HllSketchBuildAggregator.java | 1 -
.../datasketches/hll/HllSketchBuildAggregatorFactory.java | 1 -
.../datasketches/hll/HllSketchBuildBufferAggregator.java | 1 -
.../aggregation/datasketches/hll/HllSketchMergeAggregator.java | 1 -
.../datasketches/hll/HllSketchMergeAggregatorFactory.java | 1 -
.../datasketches/hll/HllSketchMergeBufferAggregator.java | 1 -
.../query/aggregation/datasketches/hll/HllSketchModule.java | 1 -
.../hll/HllSketchToEstimateWithBoundsPostAggregator.java | 1 -
.../datasketches/hll/HllSketchToStringPostAggregator.java | 1 -
.../datasketches/hll/HllSketchUnionPostAggregator.java | 1 -
19 files changed, 9 insertions(+), 24 deletions(-)
diff --git a/codestyle/checkstyle.xml b/codestyle/checkstyle.xml
index 786b182..12e9532 100644
--- a/codestyle/checkstyle.xml
+++ b/codestyle/checkstyle.xml
@@ -32,6 +32,15 @@
<module name="NewlineAtEndOfFile"/>
<module name="FileTabCharacter"/>
+ <!-- Added as per the issue #7384 - Prohibit @author tags in Javadoc -->
+ <module name="RegexpSingleline">
+ <property name="format" value="^\s*\*\s*@author" />
+ <property name="minimum" value="0" />
+ <property name="maximum" value="0" />
+ <property name="message" value="Prohibit @author tags in Javadoc" />
+ <property name="fileExtensions" value="java" />
+ </module>
+
<module name="TreeWalker">
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="CHECKSTYLE.OFF\: ([\w\|]+)"/>
diff --git
a/core/src/main/java/org/apache/druid/java/util/common/io/Closer.java
b/core/src/main/java/org/apache/druid/java/util/common/io/Closer.java
index 5bba0db..f5bfb2c 100644
--- a/core/src/main/java/org/apache/druid/java/util/common/io/Closer.java
+++ b/core/src/main/java/org/apache/druid/java/util/common/io/Closer.java
@@ -85,7 +85,6 @@ import java.util.Deque;
* careful to ensure that Closer is not used in code that might be executed by
Hadoop indexing service. We copy Closer
* to Druid codebase in order to remove this headache.
*
- * @author Colin Decker
* @since Guava 14.0
*/
// Coffee's for {@link Closer closers} only.
diff --git
a/examples/src/main/java/org/apache/druid/examples/twitter/TwitterSpritzerFirehoseFactory.java
b/examples/src/main/java/org/apache/druid/examples/twitter/TwitterSpritzerFirehoseFactory.java
index dc951e8..65bdacd 100644
---
a/examples/src/main/java/org/apache/druid/examples/twitter/TwitterSpritzerFirehoseFactory.java
+++
b/examples/src/main/java/org/apache/druid/examples/twitter/TwitterSpritzerFirehoseFactory.java
@@ -78,8 +78,6 @@ import java.util.regex.Pattern;
* can have number format exceptions), so it might be necessary to extract raw
json and process it
* separately. If so, set twitter4.jsonStoreEnabled=true and look at
DataObjectFactory#getRawJSON();
* com.fasterxml.jackson.databind.ObjectMapper should be used to parse.
- *
- * @author pbaclace
*/
@JsonTypeName("twitzer")
public class TwitterSpritzerFirehoseFactory implements
FirehoseFactory<InputRowParser>
diff --git
a/extendedset/src/main/java/org/apache/druid/extendedset/intset/AbstractIntSet.java
b/extendedset/src/main/java/org/apache/druid/extendedset/intset/AbstractIntSet.java
index aecee12..0f4ef59 100755
---
a/extendedset/src/main/java/org/apache/druid/extendedset/intset/AbstractIntSet.java
+++
b/extendedset/src/main/java/org/apache/druid/extendedset/intset/AbstractIntSet.java
@@ -23,7 +23,6 @@ package org.apache.druid.extendedset.intset;
* This class provides a skeletal implementation of the {@link IntSet}
* interface to minimize the effort required to implement this interface.
*
- * @author Alessandro Colantonio
* @version $Id: AbstractIntSet.java 156 2011-09-01 00:13:57Z cocciasik $
*/
public abstract class AbstractIntSet implements IntSet
diff --git
a/extendedset/src/main/java/org/apache/druid/extendedset/intset/ConciseSet.java
b/extendedset/src/main/java/org/apache/druid/extendedset/intset/ConciseSet.java
index a7db53b..5bce561 100755
---
a/extendedset/src/main/java/org/apache/druid/extendedset/intset/ConciseSet.java
+++
b/extendedset/src/main/java/org/apache/druid/extendedset/intset/ConciseSet.java
@@ -49,7 +49,6 @@ import java.util.NoSuchElementException;
* depended on this exception for its correctness: <i>the fail-fast behavior of
* iterators should be used only to detect bugs.</i>
*
- * @author Alessandro Colantonio
* @version $Id$
*/
public class ConciseSet extends AbstractIntSet implements Serializable
@@ -2090,9 +2089,6 @@ public class ConciseSet extends AbstractIntSet implements
Serializable
}
}
- /**
- * @author alessandrocolantonio
- */
private class ReverseBitIterator implements IntIterator
{
/**
diff --git
a/extendedset/src/main/java/org/apache/druid/extendedset/intset/IntSet.java
b/extendedset/src/main/java/org/apache/druid/extendedset/intset/IntSet.java
index 1e86850..df90c1c 100755
--- a/extendedset/src/main/java/org/apache/druid/extendedset/intset/IntSet.java
+++ b/extendedset/src/main/java/org/apache/druid/extendedset/intset/IntSet.java
@@ -23,7 +23,6 @@ import java.util.Iterator;
import java.util.NoSuchElementException;
/**
- * @author Alessandro Colantonio
* @version $Id: IntSet.java 135 2011-01-04 15:54:48Z cocciasik $
*/
public interface IntSet extends Cloneable, Comparable<IntSet>
diff --git
a/extensions-contrib/cassandra-storage/src/main/java/org/apache/druid/storage/cassandra/CassandraDataSegmentConfig.java
b/extensions-contrib/cassandra-storage/src/main/java/org/apache/druid/storage/cassandra/CassandraDataSegmentConfig.java
index 0b25bb3..6302e3d 100644
---
a/extensions-contrib/cassandra-storage/src/main/java/org/apache/druid/storage/cassandra/CassandraDataSegmentConfig.java
+++
b/extensions-contrib/cassandra-storage/src/main/java/org/apache/druid/storage/cassandra/CassandraDataSegmentConfig.java
@@ -25,8 +25,6 @@ import javax.validation.constraints.NotNull;
/**
* Cassandra Config
- *
- * @author boneill42
*/
public class CassandraDataSegmentConfig
{
diff --git
a/extensions-contrib/cassandra-storage/src/main/java/org/apache/druid/storage/cassandra/CassandraDataSegmentPusher.java
b/extensions-contrib/cassandra-storage/src/main/java/org/apache/druid/storage/cassandra/CassandraDataSegmentPusher.java
index 61420d2..0f7d9a2 100644
---
a/extensions-contrib/cassandra-storage/src/main/java/org/apache/druid/storage/cassandra/CassandraDataSegmentPusher.java
+++
b/extensions-contrib/cassandra-storage/src/main/java/org/apache/druid/storage/cassandra/CassandraDataSegmentPusher.java
@@ -41,8 +41,6 @@ import java.util.Map;
/**
* Cassandra Segment Pusher
- *
- * @author boneill42
*/
public class CassandraDataSegmentPusher extends CassandraStorage implements
DataSegmentPusher
{
diff --git
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchAggregatorFactory.java
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchAggregatorFactory.java
index 2da37b8..b10c8c3 100644
---
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchAggregatorFactory.java
+++
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchAggregatorFactory.java
@@ -37,7 +37,6 @@ import java.util.Objects;
/**
* Base class for both build and merge factories
- * @author Alexander Saydakov
*/
public abstract class HllSketchAggregatorFactory extends AggregatorFactory
{
diff --git
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchBuildAggregator.java
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchBuildAggregator.java
index f4a4e1e..66c2036 100644
---
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchBuildAggregator.java
+++
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchBuildAggregator.java
@@ -28,7 +28,6 @@ import org.apache.druid.segment.ColumnValueSelector;
/**
* This aggregator builds sketches from raw data.
* The input column can contain identifiers of type string, char[], byte[] or
any numeric type.
- * @author Alexander Saydakov
*/
public class HllSketchBuildAggregator implements Aggregator
{
diff --git
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchBuildAggregatorFactory.java
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchBuildAggregatorFactory.java
index edf019f..8668b78 100644
---
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchBuildAggregatorFactory.java
+++
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchBuildAggregatorFactory.java
@@ -34,7 +34,6 @@ import javax.annotation.Nullable;
/**
* This aggregator factory is for building sketches from raw data.
* The input column can contain identifiers of type string, char[], byte[] or
any numeric type.
- * @author Alexander Saydakov
*/
public class HllSketchBuildAggregatorFactory extends HllSketchAggregatorFactory
{
diff --git
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchBuildBufferAggregator.java
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchBuildBufferAggregator.java
index ce15821..5532866 100644
---
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchBuildBufferAggregator.java
+++
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchBuildBufferAggregator.java
@@ -38,7 +38,6 @@ import java.util.concurrent.locks.ReadWriteLock;
/**
* This aggregator builds sketches from raw data.
* The input column can contain identifiers of type string, char[], byte[] or
any numeric type.
- * @author Alexander Saydakov
*/
public class HllSketchBuildBufferAggregator implements BufferAggregator
{
diff --git
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchMergeAggregator.java
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchMergeAggregator.java
index 14538f3..af046bc 100644
---
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchMergeAggregator.java
+++
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchMergeAggregator.java
@@ -28,7 +28,6 @@ import org.apache.druid.segment.ColumnValueSelector;
/**
* This aggregator merges existing sketches.
* The input column must contain {@link HllSketch}
- * @author Alexander Saydakov
*/
public class HllSketchMergeAggregator implements Aggregator
{
diff --git
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchMergeAggregatorFactory.java
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchMergeAggregatorFactory.java
index b82b35b..3f4cbc2 100644
---
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchMergeAggregatorFactory.java
+++
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchMergeAggregatorFactory.java
@@ -37,7 +37,6 @@ import javax.annotation.Nullable;
/**
* This aggregator factory is for merging existing sketches.
* The input column must contain {@link HllSketch}
- * @author Alexander Saydakov
*/
public class HllSketchMergeAggregatorFactory extends HllSketchAggregatorFactory
{
diff --git
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchMergeBufferAggregator.java
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchMergeBufferAggregator.java
index eec9ef2..0167e1a 100644
---
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchMergeBufferAggregator.java
+++
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchMergeBufferAggregator.java
@@ -36,7 +36,6 @@ import java.util.concurrent.locks.ReadWriteLock;
/**
* This aggregator merges existing sketches.
* The input column must contain {@link HllSketch}
- * @author Alexander Saydakov
*/
public class HllSketchMergeBufferAggregator implements BufferAggregator
{
diff --git
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchModule.java
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchModule.java
index 5a183d9..1d2c081 100644
---
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchModule.java
+++
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchModule.java
@@ -36,7 +36,6 @@ import java.util.List;
/**
* This module is to support count-distinct operations using {@link HllSketch}.
* See <a href="https://datasketches.github.io/docs/HLL/HLL.html";>HyperLogLog
Sketch documentation</a>
- * @author Alexander Saydakov
*/
public class HllSketchModule implements DruidModule
{
diff --git
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchToEstimateWithBoundsPostAggregator.java
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchToEstimateWithBoundsPostAggregator.java
index f139456..cd40c52 100644
---
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchToEstimateWithBoundsPostAggregator.java
+++
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchToEstimateWithBoundsPostAggregator.java
@@ -40,7 +40,6 @@ import java.util.Set;
* The bounds are provided at a given number of standard deviations (optional,
defaults to 1).
* This must be an integer value of 1, 2 or 3 corresponding to approximately
68.3%, 95.4% and 99.7%
* confidence intervals.
- * @author Alexander Saydakov
*/
public class HllSketchToEstimateWithBoundsPostAggregator implements
PostAggregator
{
diff --git
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchToStringPostAggregator.java
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchToStringPostAggregator.java
index 19a1614..861d570 100644
---
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchToStringPostAggregator.java
+++
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchToStringPostAggregator.java
@@ -36,7 +36,6 @@ import java.util.Set;
* Returns a human-readable summary of a given {@link HllSketch}.
* This is a string returned by toString() method of the sketch.
* This can be useful for debugging.
- * @author Alexander Saydakov
*/
public class HllSketchToStringPostAggregator implements PostAggregator
{
diff --git
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchUnionPostAggregator.java
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchUnionPostAggregator.java
index 65988d7..daf0273 100644
---
a/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchUnionPostAggregator.java
+++
b/extensions-core/datasketches/src/main/java/org/apache/druid/query/aggregation/datasketches/hll/HllSketchUnionPostAggregator.java
@@ -39,7 +39,6 @@ import java.util.Set;
/**
* Returns a union of a given list of sketches.
- * @author Alexander Saydakov
*/
public class HllSketchUnionPostAggregator implements PostAggregator
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
