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, 27 Apr 2015 04:29:05 GMT
Repository: cassandra
Updated Branches:
  refs/heads/trunk d06dbbbf7 -> 246f07b68


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

Branch: refs/heads/trunk
Commit: 246f07b6806f48deb371a4a8ec47131c0f0a606d
Parents: d06dbbb
Author: Dave Brosius <dbrosius@mebigfatguy.com>
Authored: Mon Apr 27 00:28:53 2015 -0400
Committer: Dave Brosius <dbrosius@mebigfatguy.com>
Committed: Mon Apr 27 00:28:53 2015 -0400

----------------------------------------------------------------------
 src/java/org/apache/cassandra/auth/IRoleManager.java            | 2 +-
 src/java/org/apache/cassandra/auth/PasswordAuthenticator.java   | 2 +-
 src/java/org/apache/cassandra/config/Schema.java                | 2 +-
 .../cassandra/cql3/restrictions/MultiColumnRestriction.java     | 2 +-
 src/java/org/apache/cassandra/db/Directories.java               | 4 +++-
 .../org/apache/cassandra/io/sstable/format/SSTableReader.java   | 5 ++++-
 .../cassandra/io/util/UnbufferedDataOutputStreamPlus.java       | 3 ++-
 .../org/apache/cassandra/metrics/CassandraMetricsRegistry.java  | 3 ++-
 src/java/org/apache/cassandra/repair/messages/RepairOption.java | 1 +
 .../org/apache/cassandra/thrift/CustomTThreadPoolServer.java    | 2 +-
 src/java/org/apache/cassandra/tools/NodeProbe.java              | 2 +-
 .../org/apache/cassandra/transport/messages/AuthResponse.java   | 2 +-
 12 files changed, 19 insertions(+), 11 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cassandra/blob/246f07b6/src/java/org/apache/cassandra/auth/IRoleManager.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/auth/IRoleManager.java b/src/java/org/apache/cassandra/auth/IRoleManager.java
index a8befde..5afc7f3 100644
--- a/src/java/org/apache/cassandra/auth/IRoleManager.java
+++ b/src/java/org/apache/cassandra/auth/IRoleManager.java
@@ -27,7 +27,7 @@ import org.apache.cassandra.exceptions.RequestValidationException;
 /**
  * Responsible for managing roles (which also includes what
  * used to be known as users), including creation, deletion,
- * alteration and the granting & revoking of roles to other
+ * alteration and the granting and revoking of roles to other
  * roles.
  */
 public interface IRoleManager

http://git-wip-us.apache.org/repos/asf/cassandra/blob/246f07b6/src/java/org/apache/cassandra/auth/PasswordAuthenticator.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/auth/PasswordAuthenticator.java b/src/java/org/apache/cassandra/auth/PasswordAuthenticator.java
index 2ab2316..6803e21 100644
--- a/src/java/org/apache/cassandra/auth/PasswordAuthenticator.java
+++ b/src/java/org/apache/cassandra/auth/PasswordAuthenticator.java
@@ -48,7 +48,7 @@ import static org.apache.cassandra.auth.CassandraRoleManager.consistencyForRole;
  * Since 3.0, the management of roles (creation, modification,
  * querying etc is the responsibility of IRoleManager. Use of
  * PasswordAuthenticator requires the use of CassandraRoleManager
- * for storage & retrieval of encryted passwords.
+ * for storage and retrieval of encrypted passwords.
  */
 public class PasswordAuthenticator implements IAuthenticator
 {

http://git-wip-us.apache.org/repos/asf/cassandra/blob/246f07b6/src/java/org/apache/cassandra/config/Schema.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/config/Schema.java b/src/java/org/apache/cassandra/config/Schema.java
index af1b502..5429f07 100644
--- a/src/java/org/apache/cassandra/config/Schema.java
+++ b/src/java/org/apache/cassandra/config/Schema.java
@@ -204,7 +204,7 @@ public class Schema
     }
 
     /**
-     * Given a keyspace name & column family name, get the column family
+     * Given a keyspace name and column family name, get the column family
      * meta data. If the keyspace name or column family name is not valid
      * this function returns null.
      *

http://git-wip-us.apache.org/repos/asf/cassandra/blob/246f07b6/src/java/org/apache/cassandra/cql3/restrictions/MultiColumnRestriction.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/cql3/restrictions/MultiColumnRestriction.java b/src/java/org/apache/cassandra/cql3/restrictions/MultiColumnRestriction.java
index 3a755f0..6d3ffab 100644
--- a/src/java/org/apache/cassandra/cql3/restrictions/MultiColumnRestriction.java
+++ b/src/java/org/apache/cassandra/cql3/restrictions/MultiColumnRestriction.java
@@ -85,7 +85,7 @@ public abstract class MultiColumnRestriction extends AbstractRestriction
      * Returns the names of the columns that are specified within this <code>Restrictions</code>
and the other one
      * as a comma separated <code>String</code>.
      *
-     * @param otherRestrictions the other restrictions
+     * @param otherRestriction the other restrictions
      * @return the names of the columns that are specified within this <code>Restrictions</code>
and the other one
      * as a comma separated <code>String</code>.
      */

http://git-wip-us.apache.org/repos/asf/cassandra/blob/246f07b6/src/java/org/apache/cassandra/db/Directories.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/Directories.java b/src/java/org/apache/cassandra/db/Directories.java
index d1c6500..4b6797f 100644
--- a/src/java/org/apache/cassandra/db/Directories.java
+++ b/src/java/org/apache/cassandra/db/Directories.java
@@ -55,16 +55,18 @@ import org.apache.cassandra.utils.Pair;
  * Encapsulate handling of paths to the data files.
  *
  * Since v2.1, the directory layout is the following:
+ * <pre> {@code
  *   /<path_to_data_dir>/ks/cf1-cfId/ks-cf1-ka-1-Data.db
  *                         /cf2-cfId/ks-cf2-ka-1-Data.db
  *                         ...
+ * } </pre>                      
  *
  * cfId is an hex encoded CFID.
  *
  * For backward compatibility, Directories uses older directory layout if exists.
  *
  * In addition, more that one 'root' data directory can be specified so that
- * <path_to_data_dir> potentially represents multiple locations.
+ * {@code <path_to_data_dir>} potentially represents multiple locations.
  * Note that in the case of multiple locations, the manifest for the leveled
  * compaction is only in one of the location.
  *

http://git-wip-us.apache.org/repos/asf/cassandra/blob/246f07b6/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 ff7db4a..4411ca7 100644
--- a/src/java/org/apache/cassandra/io/sstable/format/SSTableReader.java
+++ b/src/java/org/apache/cassandra/io/sstable/format/SSTableReader.java
@@ -71,7 +71,9 @@ import static org.apache.cassandra.db.Directories.SECONDARY_INDEX_NAME_SEPARATOR
  * to replace some existing sstables. However once created, an sstablereader may also be
modified.
  *
  * A reader's OpenReason describes its current stage in its lifecycle, as follows:
- *
+ * 
+ * 
+ * <pre> {@code
  * NORMAL
  * From:       None        => Reader has been read from disk, either at startup or from
a flushed memtable
  *             EARLY       => Reader is the final result of a compaction
@@ -93,6 +95,7 @@ import static org.apache.cassandra.db.Directories.SECONDARY_INDEX_NAME_SEPARATOR
  * From:       NORMAL      => Reader has seen low traffic and the amount of memory available
for index summaries is
  *                            constrained, so its index summary has been downsampled.
  *         METADATA_CHANGE => Same
+ * } </pre>
  *
  * Note that in parallel to this, there are two different Descriptor types; TMPLINK and FINAL;
the latter corresponds
  * to NORMAL state readers and all readers that replace a NORMAL one. TMPLINK is used for
EARLY state readers and

http://git-wip-us.apache.org/repos/asf/cassandra/blob/246f07b6/src/java/org/apache/cassandra/io/util/UnbufferedDataOutputStreamPlus.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/io/util/UnbufferedDataOutputStreamPlus.java b/src/java/org/apache/cassandra/io/util/UnbufferedDataOutputStreamPlus.java
index 70435a1..d8036ff 100644
--- a/src/java/org/apache/cassandra/io/util/UnbufferedDataOutputStreamPlus.java
+++ b/src/java/org/apache/cassandra/io/util/UnbufferedDataOutputStreamPlus.java
@@ -31,9 +31,10 @@ import com.google.common.base.Function;
 /**
  * Base class for DataOutput implementations that does not have an optimized implementations
of Plus methods
  * and does no buffering.
- * <p/>
+ * <p>
  * Unlike BufferedDataOutputStreamPlus this is capable of operating as an unbuffered output
stream.
  * Currently necessary because SequentialWriter implements its own buffering along with mark/reset/truncate.
+ * </p>
  */
 public abstract class UnbufferedDataOutputStreamPlus extends DataOutputStreamPlus
 {

http://git-wip-us.apache.org/repos/asf/cassandra/blob/246f07b6/src/java/org/apache/cassandra/metrics/CassandraMetricsRegistry.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/metrics/CassandraMetricsRegistry.java b/src/java/org/apache/cassandra/metrics/CassandraMetricsRegistry.java
index 27eec89..2f76adb 100644
--- a/src/java/org/apache/cassandra/metrics/CassandraMetricsRegistry.java
+++ b/src/java/org/apache/cassandra/metrics/CassandraMetricsRegistry.java
@@ -30,8 +30,9 @@ import javax.management.*;
 
 /**
  * Makes integrating 3.0 metrics API with 2.0.
- * <p/>
+ * <p>
  * The 3.0 API comes with poor JMX integration
+ * </p>
  */
 public class CassandraMetricsRegistry extends MetricRegistry
 {

http://git-wip-us.apache.org/repos/asf/cassandra/blob/246f07b6/src/java/org/apache/cassandra/repair/messages/RepairOption.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/repair/messages/RepairOption.java b/src/java/org/apache/cassandra/repair/messages/RepairOption.java
index 5987aed..a13d0fe 100644
--- a/src/java/org/apache/cassandra/repair/messages/RepairOption.java
+++ b/src/java/org/apache/cassandra/repair/messages/RepairOption.java
@@ -53,6 +53,7 @@ public class RepairOption
      * Available options are:
      *
      * <table>
+     *     <caption>Repair Options</caption>
      *     <thead>
      *         <tr>
      *             <th>key</th>

http://git-wip-us.apache.org/repos/asf/cassandra/blob/246f07b6/src/java/org/apache/cassandra/thrift/CustomTThreadPoolServer.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/thrift/CustomTThreadPoolServer.java b/src/java/org/apache/cassandra/thrift/CustomTThreadPoolServer.java
index 7e67110..e7584c9 100644
--- a/src/java/org/apache/cassandra/thrift/CustomTThreadPoolServer.java
+++ b/src/java/org/apache/cassandra/thrift/CustomTThreadPoolServer.java
@@ -54,7 +54,7 @@ import com.google.common.util.concurrent.Uninterruptibles;
 
 /**
  * Slightly modified version of the Apache Thrift TThreadPoolServer.
- * <p/>
+ * <p>
  * This allows passing an executor so you have more control over the actual
  * behaviour of the tasks being run.
  * <p/>

http://git-wip-us.apache.org/repos/asf/cassandra/blob/246f07b6/src/java/org/apache/cassandra/tools/NodeProbe.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/tools/NodeProbe.java b/src/java/org/apache/cassandra/tools/NodeProbe.java
index c0c60e5..6496319 100644
--- a/src/java/org/apache/cassandra/tools/NodeProbe.java
+++ b/src/java/org/apache/cassandra/tools/NodeProbe.java
@@ -510,7 +510,7 @@ public class NodeProbe implements AutoCloseable
      * 
      * @param snapshotName
      *            the name of the snapshot.
-     * @param columnfamilylist
+     * @param columnFamilyList
      *            list of columnfamily from different keyspace in the form of ks1.cf1 ks2.cf2
      */
     public void takeMultipleColumnFamilySnapshot(String snapshotName, String... columnFamilyList)

http://git-wip-us.apache.org/repos/asf/cassandra/blob/246f07b6/src/java/org/apache/cassandra/transport/messages/AuthResponse.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/transport/messages/AuthResponse.java b/src/java/org/apache/cassandra/transport/messages/AuthResponse.java
index cb67476..257a26a 100644
--- a/src/java/org/apache/cassandra/transport/messages/AuthResponse.java
+++ b/src/java/org/apache/cassandra/transport/messages/AuthResponse.java
@@ -28,7 +28,7 @@ import org.apache.cassandra.transport.*;
 
 /**
  * A SASL token message sent from client to server. Some SASL
- * mechanisms & clients may send an initial token before
+ * mechanisms and clients may send an initial token before
  * receiving a challenge from the server.
  */
 public class AuthResponse extends Message.Request


Mime
View raw message