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
This commit is contained in:
Merlin Lee 2019-05-20 15:09:51 +08:00 committed by Clint Wylie
parent 1add566411
commit 5f08b0b474
19 changed files with 9 additions and 24 deletions

View File

@ -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\|]+)"/>

View File

@ -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.

View File

@ -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>

View File

@ -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

View File

@ -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
{
/**

View File

@ -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>

View File

@ -25,8 +25,6 @@ import javax.validation.constraints.NotNull;
/**
* Cassandra Config
*
* @author boneill42
*/
public class CassandraDataSegmentConfig
{

View File

@ -41,8 +41,6 @@ import java.util.Map;
/**
* Cassandra Segment Pusher
*
* @author boneill42
*/
public class CassandraDataSegmentPusher extends CassandraStorage implements DataSegmentPusher
{

View File

@ -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
{

View File

@ -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
{

View File

@ -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
{

View File

@ -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
{

View File

@ -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
{

View File

@ -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
{

View File

@ -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
{

View File

@ -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
{

View File

@ -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
{

View File

@ -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
{

View File

@ -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
{