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 Tue, 03 May 2016 03:06:20 GMT
Repository: cassandra
Updated Branches:
  refs/heads/trunk df5f22843 -> fe7eee006


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/fe7eee00
Tree: http://git-wip-us.apache.org/repos/asf/cassandra/tree/fe7eee00
Diff: http://git-wip-us.apache.org/repos/asf/cassandra/diff/fe7eee00

Branch: refs/heads/trunk
Commit: fe7eee00661272bb29608e8e2cf5dea6a7511cef
Parents: df5f228
Author: Dave Brosius <dbrosius@mebigfatguy.com>
Authored: Mon May 2 23:06:04 2016 -0400
Committer: Dave Brosius <dbrosius@mebigfatguy.com>
Committed: Mon May 2 23:06:04 2016 -0400

----------------------------------------------------------------------
 .../apache/cassandra/auth/jmx/AuthenticationProxy.java  |  2 +-
 .../org/apache/cassandra/concurrent/ExecutorLocal.java  |  2 +-
 .../org/apache/cassandra/db/marshal/AbstractType.java   |  2 +-
 .../org/apache/cassandra/db/rows/RowDiffListener.java   |  2 +-
 src/java/org/apache/cassandra/db/view/ViewManager.java  |  4 ++--
 src/java/org/apache/cassandra/gms/Gossiper.java         |  2 +-
 .../cassandra/io/sstable/format/SSTableReader.java      |  2 +-
 .../io/util/RewindableDataInputStreamPlus.java          | 12 ++++++------
 .../apache/cassandra/service/StorageServiceMBean.java   |  6 +++---
 9 files changed, 17 insertions(+), 17 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cassandra/blob/fe7eee00/src/java/org/apache/cassandra/auth/jmx/AuthenticationProxy.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/auth/jmx/AuthenticationProxy.java b/src/java/org/apache/cassandra/auth/jmx/AuthenticationProxy.java
index 67c9d8c..1fe6b63 100644
--- a/src/java/org/apache/cassandra/auth/jmx/AuthenticationProxy.java
+++ b/src/java/org/apache/cassandra/auth/jmx/AuthenticationProxy.java
@@ -76,7 +76,7 @@ public final class AuthenticationProxy implements JMXAuthenticator
      *
      * @param credentials optionally these credentials may be supplied by the JMX user.
      *                    Out of the box, the JDK's {@code}RMIServerImpl{@code} is capable
-     *                    of supplying a two element String[], containing username &
password.
+     *                    of supplying a two element String[], containing username and password.
      *                    If present, these credentials will be made available to configured
      *                    {@code}LoginModule{@code}s via {@code}JMXCallbackHandler{@code}.
      *

http://git-wip-us.apache.org/repos/asf/cassandra/blob/fe7eee00/src/java/org/apache/cassandra/concurrent/ExecutorLocal.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/concurrent/ExecutorLocal.java b/src/java/org/apache/cassandra/concurrent/ExecutorLocal.java
index 47826f3..367dc7c 100644
--- a/src/java/org/apache/cassandra/concurrent/ExecutorLocal.java
+++ b/src/java/org/apache/cassandra/concurrent/ExecutorLocal.java
@@ -27,7 +27,7 @@ public interface ExecutorLocal<T>
     ExecutorLocal[] all = { Tracing.instance, ClientWarn.instance };
 
     /**
-     * This is called when scheduling the task, and also before calling {@link ExecutorLocal#set(T)}
when running on a
+     * This is called when scheduling the task, and also before calling {@link #set(Object)}
when running on a
      * executor thread.
      *
      * @return The thread-local value that we want to copy across executor boundaries; may
be null if not set.

http://git-wip-us.apache.org/repos/asf/cassandra/blob/fe7eee00/src/java/org/apache/cassandra/db/marshal/AbstractType.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/marshal/AbstractType.java b/src/java/org/apache/cassandra/db/marshal/AbstractType.java
index 7a67433..fc4ec3b 100644
--- a/src/java/org/apache/cassandra/db/marshal/AbstractType.java
+++ b/src/java/org/apache/cassandra/db/marshal/AbstractType.java
@@ -336,7 +336,7 @@ public abstract class AbstractType<T> implements Comparator<ByteBuffer>
      * Returns an AbstractType instance that is equivalent to this one, but with all nested
UDTs explicitly frozen and
      * all collections in UDTs explicitly frozen.
      *
-     * This is only necessary for 2.x -> 3.x schema migrations, and can be removed in
Cassandra 4.0.
+     * This is only necessary for {@code 2.x -> 3.x} schema migrations, and can be removed
in Cassandra 4.0.
      *
      * See CASSANDRA-11609
      */

http://git-wip-us.apache.org/repos/asf/cassandra/blob/fe7eee00/src/java/org/apache/cassandra/db/rows/RowDiffListener.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/rows/RowDiffListener.java b/src/java/org/apache/cassandra/db/rows/RowDiffListener.java
index f209bfc..8586a97 100644
--- a/src/java/org/apache/cassandra/db/rows/RowDiffListener.java
+++ b/src/java/org/apache/cassandra/db/rows/RowDiffListener.java
@@ -23,7 +23,7 @@ import org.apache.cassandra.db.*;
 /**
  * Interface that allows to act on the result of merging multiple rows.
  *
- * More precisely, given N rows and the result of merging them, one can call {@link Rows#diff()}
+ * More precisely, given N rows and the result of merging them, one can call {@link Rows#diff(RowDiffListener,
Row, Row...)}
  * with a {@code RowDiffListener} and that listener will be informed for each input row of
the diff between
  * that input and merge row.
  */

http://git-wip-us.apache.org/repos/asf/cassandra/blob/fe7eee00/src/java/org/apache/cassandra/db/view/ViewManager.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/view/ViewManager.java b/src/java/org/apache/cassandra/db/view/ViewManager.java
index 37428ad..6b8fe0d 100644
--- a/src/java/org/apache/cassandra/db/view/ViewManager.java
+++ b/src/java/org/apache/cassandra/db/view/ViewManager.java
@@ -45,8 +45,8 @@ import org.slf4j.LoggerFactory;
  * manager is initialized.
  *
  * The main purposes of the manager are to provide a single location for updates to be vetted
to see whether they update
- * any views {@link ViewManager#updatesAffectView(Collection, boolean)}, provide locks to
prevent multiple
- * updates from creating incoherent updates in the view {@link ViewManager#acquireLockFor(ByteBuffer)},
and
+ * any views {@link #updatesAffectView(Collection, boolean)}, provide locks to prevent multiple
+ * updates from creating incoherent updates in the view {@link #acquireLockFor(int)}, and
  * to affect change on the view.
  */
 public class ViewManager

http://git-wip-us.apache.org/repos/asf/cassandra/blob/fe7eee00/src/java/org/apache/cassandra/gms/Gossiper.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/gms/Gossiper.java b/src/java/org/apache/cassandra/gms/Gossiper.java
index 76e7577..c5d243f 100644
--- a/src/java/org/apache/cassandra/gms/Gossiper.java
+++ b/src/java/org/apache/cassandra/gms/Gossiper.java
@@ -711,7 +711,7 @@ public class Gossiper implements IFailureDetectionEventListener, GossiperMBean
     /**
      * Check if this node can safely be started and join the ring.
      * If the node is bootstrapping, examines gossip state for any previous status to decide
whether
-     * it's safe to allow this node to start & bootstrap. If not bootstrapping, compares
the host ID
+     * it's safe to allow this node to start and bootstrap. If not bootstrapping, compares
the host ID
      * that the node itself has (obtained by reading from system.local or generated if not
present)
      * with the host ID obtained from gossip for the endpoint address (if any). This latter
case
      * prevents a non-bootstrapping, new node from being started with the same address of
a

http://git-wip-us.apache.org/repos/asf/cassandra/blob/fe7eee00/src/java/org/apache/cassandra/io/sstable/format/SSTableReader.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/io/sstable/format/SSTableReader.java b/src/java/org/apache/cassandra/io/sstable/format/SSTableReader.java
index a77b673..57c985d 100644
--- a/src/java/org/apache/cassandra/io/sstable/format/SSTableReader.java
+++ b/src/java/org/apache/cassandra/io/sstable/format/SSTableReader.java
@@ -1762,7 +1762,7 @@ public abstract class SSTableReader extends SSTable implements SelfRefCounted<SS
     /**
      * Direct I/O SSTableScanner over an iterator of bounds.
      *
-     * @param bounds the keys to cover
+     * @param rangeIterator the keys to cover
      * @return A Scanner for seeking over the rows of the SSTable.
      */
     public abstract ISSTableScanner getScanner(Iterator<AbstractBounds<PartitionPosition>>
rangeIterator);

http://git-wip-us.apache.org/repos/asf/cassandra/blob/fe7eee00/src/java/org/apache/cassandra/io/util/RewindableDataInputStreamPlus.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/io/util/RewindableDataInputStreamPlus.java b/src/java/org/apache/cassandra/io/util/RewindableDataInputStreamPlus.java
index 3a680f4..af4d4a0 100644
--- a/src/java/org/apache/cassandra/io/util/RewindableDataInputStreamPlus.java
+++ b/src/java/org/apache/cassandra/io/util/RewindableDataInputStreamPlus.java
@@ -33,19 +33,19 @@ import static org.apache.cassandra.utils.Throwables.merge;
  * Adds mark/reset functionality to another input stream by caching read bytes to a memory
buffer and
  * spilling to disk if necessary.
  *
- * When the stream is marked via {@link this#mark()} or {@link this#mark(int)}, up to
+ * When the stream is marked via {@link #mark()} or {@link #mark(int)}, up to
  * <code>maxMemBufferSize</code> will be cached in memory (heap). If more than
  * <code>maxMemBufferSize</code> bytes are read while the stream is marked, the
  * following bytes are cached on the <code>spillFile</code> for up to <code>maxDiskBufferSize</code>.
  *
- * Please note that successive calls to {@link this#mark()} and {@link this#reset()} will
write
+ * Please note that successive calls to {@link #mark()} and {@link #reset()} will write
  * sequentially to the same <code>spillFile</code> until <code>maxDiskBufferSize</code>
is reached.
  * At this point, if less than <code>maxDiskBufferSize</code> bytes are currently
cached on the
  * <code>spillFile</code>, the remaining bytes are written to the beginning of
the file,
  * treating the <code>spillFile</code> as a circular buffer.
  *
  * If more than <code>maxMemBufferSize + maxDiskBufferSize</code> are cached
while the stream is marked,
- * the following {@link this#reset()} invocation will throw a {@link IllegalStateException}.
+ * the following {@link #reset()} invocation will throw a {@link IllegalStateException}.
  *
  */
 public class RewindableDataInputStreamPlus extends FilterInputStream implements RewindableDataInput,
Closeable
@@ -83,7 +83,7 @@ public class RewindableDataInputStreamPlus extends FilterInputStream implements
     /* RewindableDataInput methods */
 
     /**
-     * Marks the current position of a stream to return to this position later via the {@link
this#reset(DataPosition)} method.
+     * Marks the current position of a stream to return to this position later via the {@link
#reset(DataPosition)} method.
      * @return An empty @link{DataPosition} object
      */
     public DataPosition mark()
@@ -93,7 +93,7 @@ public class RewindableDataInputStreamPlus extends FilterInputStream implements
     }
 
     /**
-     * Rewinds to the previously marked position via the {@link this#mark()} method.
+     * Rewinds to the previously marked position via the {@link #mark()} method.
      * @param mark it's not possible to return to a custom position, so this parameter is
ignored.
      * @throws IOException if an error ocurs while resetting
      */
@@ -121,7 +121,7 @@ public class RewindableDataInputStreamPlus extends FilterInputStream implements
 
     /**
      * Marks the current position of a stream to return to this position
-     * later via the {@link this#reset()} method.
+     * later via the {@link #reset()} method.
      * @param readlimit the maximum amount of bytes to cache
      */
     public synchronized void mark(int readlimit)

http://git-wip-us.apache.org/repos/asf/cassandra/blob/fe7eee00/src/java/org/apache/cassandra/service/StorageServiceMBean.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/service/StorageServiceMBean.java b/src/java/org/apache/cassandra/service/StorageServiceMBean.java
index 277fbe9..f7da817 100644
--- a/src/java/org/apache/cassandra/service/StorageServiceMBean.java
+++ b/src/java/org/apache/cassandra/service/StorageServiceMBean.java
@@ -194,19 +194,19 @@ public interface StorageServiceMBean extends NotificationEmitter
     public List<InetAddress> getNaturalEndpoints(String keyspaceName, ByteBuffer key);
 
     /**
-     * @deprecated use {@link #takeSnapshot(String tag, Map options, boolean keyspaces, String...
entities)} instead.
+     * @deprecated use {@link #takeSnapshot(String tag, Map options, String... entities)}
instead.
      */
     @Deprecated
     public void takeSnapshot(String tag, String... keyspaceNames) throws IOException;
 
     /**
-     * @deprecated use {@link #takeSnapshot(String tag, Map options, boolean keyspaces, String...
entities)} instead.
+     * @deprecated use {@link #takeSnapshot(String tag, Map options, String... entities)}
instead.
      */
     @Deprecated
     public void takeTableSnapshot(String keyspaceName, String tableName, String tag) throws
IOException;
 
     /**
-     * @deprecated use {@link #takeSnapshot(String tag, Map options, boolean keyspaces, String...
entities)} instead.
+     * @deprecated use {@link #takeSnapshot(String tag, Map options, String... entities)}
instead.
      */
     @Deprecated
     public void takeMultipleTableSnapshot(String tag, String... tableList) throws IOException;


Mime
View raw message