cassandra-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dbros...@apache.org
Subject cassandra git commit: minor javadoc fixes
Date Mon, 23 Jan 2017 02:36:50 GMT
Repository: cassandra
Updated Branches:
  refs/heads/trunk bb8283850 -> 5b95ebdaf


minor javadoc fixes


Project: http://git-wip-us.apache.org/repos/asf/cassandra/repo
Commit: http://git-wip-us.apache.org/repos/asf/cassandra/commit/5b95ebda
Tree: http://git-wip-us.apache.org/repos/asf/cassandra/tree/5b95ebda
Diff: http://git-wip-us.apache.org/repos/asf/cassandra/diff/5b95ebda

Branch: refs/heads/trunk
Commit: 5b95ebdafdc742d80ae6b2408387c179677f7572
Parents: bb82838
Author: Dave Brosius <dbrosius@mebigfatguy.com>
Authored: Sun Jan 22 21:36:37 2017 -0500
Committer: Dave Brosius <dbrosius@mebigfatguy.com>
Committed: Sun Jan 22 21:36:37 2017 -0500

----------------------------------------------------------------------
 src/java/org/apache/cassandra/config/Config.java              | 2 +-
 src/java/org/apache/cassandra/config/DatabaseDescriptor.java  | 2 +-
 src/java/org/apache/cassandra/cql3/Maps.java                  | 2 +-
 src/java/org/apache/cassandra/cql3/UserTypes.java             | 1 -
 .../org/apache/cassandra/cql3/statements/ParsedStatement.java | 2 +-
 src/java/org/apache/cassandra/db/Keyspace.java                | 1 -
 src/java/org/apache/cassandra/db/ReadQuery.java               | 2 +-
 src/java/org/apache/cassandra/db/RowIndexEntry.java           | 5 +----
 .../org/apache/cassandra/db/commitlog/CommitLogReader.java    | 2 +-
 src/java/org/apache/cassandra/dht/IPartitioner.java           | 2 +-
 .../index/sasi/analyzer/StandardTokenizerInterface.java       | 2 +-
 src/java/org/apache/cassandra/net/BackPressureStrategy.java   | 3 ++-
 .../org/apache/cassandra/net/RateBasedBackPressureState.java  | 7 +++----
 src/java/org/apache/cassandra/utils/SlidingTimeRate.java      | 3 ++-
 14 files changed, 16 insertions(+), 20 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cassandra/blob/5b95ebda/src/java/org/apache/cassandra/config/Config.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/config/Config.java b/src/java/org/apache/cassandra/config/Config.java
index 6fb999e..ab5a2de 100644
--- a/src/java/org/apache/cassandra/config/Config.java
+++ b/src/java/org/apache/cassandra/config/Config.java
@@ -96,7 +96,7 @@ public class Config
     public volatile long truncate_request_timeout_in_ms = 60000L;
 
     /**
-     * @deprecated use {@link this#streaming_keep_alive_period_in_secs} instead
+     * @deprecated use {@link #streaming_keep_alive_period_in_secs} instead
      */
     @Deprecated
     public int streaming_socket_timeout_in_ms = 86400000; //24 hours

http://git-wip-us.apache.org/repos/asf/cassandra/blob/5b95ebda/src/java/org/apache/cassandra/config/DatabaseDescriptor.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/config/DatabaseDescriptor.java b/src/java/org/apache/cassandra/config/DatabaseDescriptor.java
index 5aa7065..9f1838f 100644
--- a/src/java/org/apache/cassandra/config/DatabaseDescriptor.java
+++ b/src/java/org/apache/cassandra/config/DatabaseDescriptor.java
@@ -2016,7 +2016,7 @@ public class DatabaseDescriptor
     }
 
     /**
-     * @deprecated use {@link this#getStreamingKeepAlivePeriod()} instead
+     * @deprecated use {@link #getStreamingKeepAlivePeriod()} instead
      * @return streaming_socket_timeout_in_ms property
      */
     @Deprecated

http://git-wip-us.apache.org/repos/asf/cassandra/blob/5b95ebda/src/java/org/apache/cassandra/cql3/Maps.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/cql3/Maps.java b/src/java/org/apache/cassandra/cql3/Maps.java
index 6189285..c98b829 100644
--- a/src/java/org/apache/cassandra/cql3/Maps.java
+++ b/src/java/org/apache/cassandra/cql3/Maps.java
@@ -81,7 +81,7 @@ public abstract class Maps
     /**
      * Create a <code>String</code> representation of the list containing the
specified elements.
      *
-     * @param elements the list elements
+     * @param entries the list elements
      * @return a <code>String</code> representation of the list
      */
     public static <T> String mapToString(List<Pair<T, T>> entries)

http://git-wip-us.apache.org/repos/asf/cassandra/blob/5b95ebda/src/java/org/apache/cassandra/cql3/UserTypes.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/cql3/UserTypes.java b/src/java/org/apache/cassandra/cql3/UserTypes.java
index ae62177..c8ddad0 100644
--- a/src/java/org/apache/cassandra/cql3/UserTypes.java
+++ b/src/java/org/apache/cassandra/cql3/UserTypes.java
@@ -96,7 +96,6 @@ public abstract class UserTypes
      * the user type entries.
      *
      * @param items items associated to the user type entries
-     * @param mapper the mapper used to user type the items to the {@code String} representation
of the map entries
      * @return a {@code String} representation of the user type
      */
     public static <T> String userTypeToString(Map<FieldIdentifier, T> items)

http://git-wip-us.apache.org/repos/asf/cassandra/blob/5b95ebda/src/java/org/apache/cassandra/cql3/statements/ParsedStatement.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/cql3/statements/ParsedStatement.java b/src/java/org/apache/cassandra/cql3/statements/ParsedStatement.java
index c7cbb58..0cd549a 100644
--- a/src/java/org/apache/cassandra/cql3/statements/ParsedStatement.java
+++ b/src/java/org/apache/cassandra/cql3/statements/ParsedStatement.java
@@ -50,7 +50,7 @@ public abstract class ParsedStatement
     {
         /**
          * Contains the CQL statement source if the statement has been "regularly" perpared
via
-         * {@link org.apache.cassandra.cql3.QueryProcessor#prepare(java.lang.String, org.apache.cassandra.service.ClientState,
boolean)} /
+         * {@link org.apache.cassandra.cql3.QueryProcessor#prepare(java.lang.String, org.apache.cassandra.service.ClientState)}
/
          * {@link QueryHandler#prepare(java.lang.String, org.apache.cassandra.service.QueryState,
java.util.Map)}.
          * Other usages of this class may or may not contain the CQL statement source.
          */

http://git-wip-us.apache.org/repos/asf/cassandra/blob/5b95ebda/src/java/org/apache/cassandra/db/Keyspace.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/Keyspace.java b/src/java/org/apache/cassandra/db/Keyspace.java
index a550b1b..b477fa3 100644
--- a/src/java/org/apache/cassandra/db/Keyspace.java
+++ b/src/java/org/apache/cassandra/db/Keyspace.java
@@ -452,7 +452,6 @@ public class Keyspace
      * @param writeCommitLog false to disable commitlog append entirely
      * @param updateIndexes  false to disable index updates (used by CollationController
"defragmenting")
      * @param isDroppable    true if this should throw WriteTimeoutException if it does not
acquire lock within write_request_timeout_in_ms
-     * @throws ExecutionException
      */
     public void apply(final Mutation mutation,
                       final boolean writeCommitLog,

http://git-wip-us.apache.org/repos/asf/cassandra/blob/5b95ebda/src/java/org/apache/cassandra/db/ReadQuery.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/ReadQuery.java b/src/java/org/apache/cassandra/db/ReadQuery.java
index 0b20f32..806cfac 100644
--- a/src/java/org/apache/cassandra/db/ReadQuery.java
+++ b/src/java/org/apache/cassandra/db/ReadQuery.java
@@ -114,7 +114,7 @@ public interface ReadQuery
      * Execute the query locally. This is similar to {@link ReadQuery#executeInternal(ReadExecutionController)}
      * but it returns an unfiltered partition iterator that can be merged later on.
      *
-     * @param controller the {@code ReadExecutionController} protecting the read.
+     * @param executionController the {@code ReadExecutionController} protecting the read.
      * @return the result of the read query.
      */
     public UnfilteredPartitionIterator executeLocally(ReadExecutionController executionController);

http://git-wip-us.apache.org/repos/asf/cassandra/blob/5b95ebda/src/java/org/apache/cassandra/db/RowIndexEntry.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/RowIndexEntry.java b/src/java/org/apache/cassandra/db/RowIndexEntry.java
index fccc3cf..c00ea65 100644
--- a/src/java/org/apache/cassandra/db/RowIndexEntry.java
+++ b/src/java/org/apache/cassandra/db/RowIndexEntry.java
@@ -109,9 +109,6 @@ import static org.apache.cassandra.metrics.CassandraMetricsRegistry.Metrics;
  *     <li>{@link ShallowIndexedEntry} is for index entries with index samples
  *     that exceed {@link org.apache.cassandra.config.Config#column_index_cache_size_in_kb}
  *     for sstables with an offset table to the index samples.</li>
- *     <li>{@link LegacyShallowIndexedEntry} is for index entries with index samples
- *     that exceed {@link org.apache.cassandra.config.Config#column_index_cache_size_in_kb}
- *     but for legacy sstables.</li>
  * </ul>
  * <p>
  *     Since access to index samples on disk (obviously) requires some file
@@ -138,7 +135,7 @@ public class RowIndexEntry<T> implements IMeasurableMemory
     static final Histogram indexEntrySizeHistogram;
     static final Histogram indexInfoCountHistogram;
     static final Histogram indexInfoGetsHistogram;
-    static 
+    static
     {
         MetricNameFactory factory = new DefaultNameFactory("Index", "RowIndexEntry");
         indexEntrySizeHistogram = Metrics.histogram(factory.createMetricName("IndexedEntrySize"),
false);

http://git-wip-us.apache.org/repos/asf/cassandra/blob/5b95ebda/src/java/org/apache/cassandra/db/commitlog/CommitLogReader.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/commitlog/CommitLogReader.java b/src/java/org/apache/cassandra/db/commitlog/CommitLogReader.java
index eb745c7..d25609a 100644
--- a/src/java/org/apache/cassandra/db/commitlog/CommitLogReader.java
+++ b/src/java/org/apache/cassandra/db/commitlog/CommitLogReader.java
@@ -105,7 +105,7 @@ public class CommitLogReader
      * Reads mutations from file, handing them off to handler
      * @param handler Handler that will take action based on deserialized Mutations
      * @param file CommitLogSegment file to read
-     * @param minPosition Optional minimum CommitLogPosition - all segments with id >
or matching w/greater position will be read
+     * @param minPosition Optional minimum CommitLogPosition - all segments with id larger
or matching w/greater position will be read
      * @param mutationLimit Optional limit on # of mutations to replay. Local ALL_MUTATIONS
serves as marker to play all.
      * @param tolerateTruncation Whether or not we should allow truncation of this file or
throw if EOF found
      *

http://git-wip-us.apache.org/repos/asf/cassandra/blob/5b95ebda/src/java/org/apache/cassandra/dht/IPartitioner.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/dht/IPartitioner.java b/src/java/org/apache/cassandra/dht/IPartitioner.java
index e342bd0..5475f3c 100644
--- a/src/java/org/apache/cassandra/dht/IPartitioner.java
+++ b/src/java/org/apache/cassandra/dht/IPartitioner.java
@@ -45,7 +45,7 @@ public interface IPartitioner
     public Token midpoint(Token left, Token right);
 
     /**
-     * Calculate a Token which take approximate 0 <= ratioToLeft <= 1 ownership of
the given range.
+     * Calculate a Token which take {@code approximate 0 <= ratioToLeft <= 1} ownership
of the given range.
      */
     public Token split(Token left, Token right, double ratioToLeft);
 

http://git-wip-us.apache.org/repos/asf/cassandra/blob/5b95ebda/src/java/org/apache/cassandra/index/sasi/analyzer/StandardTokenizerInterface.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/index/sasi/analyzer/StandardTokenizerInterface.java
b/src/java/org/apache/cassandra/index/sasi/analyzer/StandardTokenizerInterface.java
index 57e35d7..327a674 100644
--- a/src/java/org/apache/cassandra/index/sasi/analyzer/StandardTokenizerInterface.java
+++ b/src/java/org/apache/cassandra/index/sasi/analyzer/StandardTokenizerInterface.java
@@ -46,7 +46,7 @@ public interface StandardTokenizerInterface
      * Resumes scanning until the next regular expression is matched,
      * the end of input is encountered or an I/O-Error occurs.
      *
-     * @return      the next token, {@link #YYEOF} on end of stream
+     * @return      the next token, {@link StandardTokenizerImpl#YYEOF} on end of stream
      * @exception   java.io.IOException  if any I/O-Error occurs
      */
     int getNextToken() throws IOException;

http://git-wip-us.apache.org/repos/asf/cassandra/blob/5b95ebda/src/java/org/apache/cassandra/net/BackPressureStrategy.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/net/BackPressureStrategy.java b/src/java/org/apache/cassandra/net/BackPressureStrategy.java
index b61a0a1..78f748b 100644
--- a/src/java/org/apache/cassandra/net/BackPressureStrategy.java
+++ b/src/java/org/apache/cassandra/net/BackPressureStrategy.java
@@ -23,9 +23,10 @@ import java.util.concurrent.TimeUnit;
 
 /**
  * Back-pressure algorithm interface.
- * <br/>
+ * <p>
  * For experts usage only. Implementors must provide a constructor accepting a single {@code
Map<String, Object>} argument,
  * representing any parameters eventually required by the specific implementation.
+ * </p>
  */
 public interface BackPressureStrategy<S extends BackPressureState>
 {

http://git-wip-us.apache.org/repos/asf/cassandra/blob/5b95ebda/src/java/org/apache/cassandra/net/RateBasedBackPressureState.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/net/RateBasedBackPressureState.java b/src/java/org/apache/cassandra/net/RateBasedBackPressureState.java
index 7bcfd6d..541d7a6 100644
--- a/src/java/org/apache/cassandra/net/RateBasedBackPressureState.java
+++ b/src/java/org/apache/cassandra/net/RateBasedBackPressureState.java
@@ -28,8 +28,7 @@ import org.apache.cassandra.utils.concurrent.IntervalLock;
 
 /**
  * The rate-based back-pressure state, tracked per replica host.
- * <br/><br/>
- *
+ * <p>
  * This back-pressure state is made up of the following attributes:
  * <ul>
  * <li>windowSize: the length of the back-pressure window in milliseconds.</li>
@@ -37,13 +36,13 @@ import org.apache.cassandra.utils.concurrent.IntervalLock;
  * <li>outgoingRate: the rate of back-pressure supporting outgoing messages.</li>
  * <li>rateLimiter: the rate limiter to eventually apply to outgoing messages.</li>
  * </ul>
- * <br/>
  * The incomingRate and outgoingRate are updated together when a response is received to
guarantee consistency between
  * the two.
- * <br/>
+ * <p>
  * It also provides methods to exclusively lock/release back-pressure windows at given intervals;
  * this allows to apply back-pressure even under concurrent modifications. Please also note
a read lock is acquired
  * during response processing so that no concurrent rate updates can screw rate computations.
+ * </p>
  */
 class RateBasedBackPressureState extends IntervalLock implements BackPressureState
 {

http://git-wip-us.apache.org/repos/asf/cassandra/blob/5b95ebda/src/java/org/apache/cassandra/utils/SlidingTimeRate.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/utils/SlidingTimeRate.java b/src/java/org/apache/cassandra/utils/SlidingTimeRate.java
index 3053a05..5e3936e 100644
--- a/src/java/org/apache/cassandra/utils/SlidingTimeRate.java
+++ b/src/java/org/apache/cassandra/utils/SlidingTimeRate.java
@@ -42,9 +42,10 @@ public class SlidingTimeRate
 
     /**
      * Creates a sliding rate whose time window is of the given size, with the given precision
and time unit.
-     * <br/>
+     * <p>
      * The precision defines how accurate the rate computation is, as it will be computed
over window size +/-
      * precision.
+     * </p>
      */
     public SlidingTimeRate(TimeSource timeSource, long size, long precision, TimeUnit unit)
     {


Mime
View raw message