You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cassandra.apache.org by sl...@apache.org on 2012/02/27 11:32:02 UTC

[16/16] git commit: Minor javadoc tweaks

Minor javadoc tweaks

patch by dbrosius; reviewed by slebresne for CASSANDRA-3956


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

Branch: refs/heads/trunk
Commit: 185e0250ab7e21462149f337497ea24d5da01719
Parents: 7587e73
Author: Sylvain Lebresne <sy...@datastax.com>
Authored: Mon Feb 27 10:54:09 2012 +0100
Committer: Sylvain Lebresne <sy...@datastax.com>
Committed: Mon Feb 27 10:54:09 2012 +0100

----------------------------------------------------------------------
 .../statements/CreateColumnFamilyStatement.java    |    2 --
 .../cassandra/cql3/statements/UpdateStatement.java |    6 ++----
 .../cassandra/db/ColumnFamilyStoreMBean.java       |    9 +++------
 src/java/org/apache/cassandra/db/Table.java        |    2 +-
 .../cassandra/hadoop/pig/CassandraStorage.java     |    2 +-
 .../apache/cassandra/service/CassandraDaemon.java  |    3 +--
 6 files changed, 8 insertions(+), 16 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cassandra/blob/185e0250/src/java/org/apache/cassandra/cql3/statements/CreateColumnFamilyStatement.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/cql3/statements/CreateColumnFamilyStatement.java b/src/java/org/apache/cassandra/cql3/statements/CreateColumnFamilyStatement.java
index 873c134..dfd3a48 100644
--- a/src/java/org/apache/cassandra/cql3/statements/CreateColumnFamilyStatement.java
+++ b/src/java/org/apache/cassandra/cql3/statements/CreateColumnFamilyStatement.java
@@ -89,8 +89,6 @@ public class CreateColumnFamilyStatement extends SchemaAlteringStatement
      * Returns a CFMetaData instance based on the parameters parsed from this
      * <code>CREATE</code> statement, or defaults where applicable.
      *
-     * @param keyspace keyspace to apply this column family to
-     * @param variables list of bound variables (for prepared statement)
      * @return a CFMetaData instance corresponding to the values parsed from this statement
      * @throws InvalidRequestException on failure to validate parsed parameters
      */

http://git-wip-us.apache.org/repos/asf/cassandra/blob/185e0250/src/java/org/apache/cassandra/cql3/statements/UpdateStatement.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/cql3/statements/UpdateStatement.java b/src/java/org/apache/cassandra/cql3/statements/UpdateStatement.java
index 584af58..5e4eb8c 100644
--- a/src/java/org/apache/cassandra/cql3/statements/UpdateStatement.java
+++ b/src/java/org/apache/cassandra/cql3/statements/UpdateStatement.java
@@ -57,8 +57,7 @@ public class UpdateStatement extends ModificationStatement
      * Creates a new UpdateStatement from a column family name, columns map, consistency
      * level, and key term.
      *
-     * @param keyspace Keyspace (optional)
-     * @param columnFamily column family name
+     * @param name column family name
      * @param columns a map of column name/values pairs
      * @param whereClause the where clause
      * @param attrs additional attributes for statement (CL, timestamp, timeToLive)
@@ -81,8 +80,7 @@ public class UpdateStatement extends ModificationStatement
      * key, and lists of column names and values.  It is intended for use with the
      * alternate update format, <code>INSERT</code>.
      *
-     * @param keyspace Keyspace (optional)
-     * @param columnFamily column family name
+     * @param name column family name
      * @param columnNames list of column names
      * @param columnValues list of column values (corresponds to names)
      * @param attrs additional attributes for statement (CL, timestamp, timeToLive)

http://git-wip-us.apache.org/repos/asf/cassandra/blob/185e0250/src/java/org/apache/cassandra/db/ColumnFamilyStoreMBean.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/ColumnFamilyStoreMBean.java b/src/java/org/apache/cassandra/db/ColumnFamilyStoreMBean.java
index 9054edd..a05c8da 100644
--- a/src/java/org/apache/cassandra/db/ColumnFamilyStoreMBean.java
+++ b/src/java/org/apache/cassandra/db/ColumnFamilyStoreMBean.java
@@ -144,20 +144,17 @@ public interface ColumnFamilyStoreMBean
     public void forceMajorCompaction() throws ExecutionException, InterruptedException;
 
     /**
-     * return the size of the smallest compacted row
-     * @return
+     * @return the size of the smallest compacted row
      */
     public long getMinRowSize();
 
     /**
-     * return the size of the largest compacted row
-     * @return
+     * @return the size of the largest compacted row
      */
     public long getMaxRowSize();
 
     /**
-     * return the mean size of the rows compacted
-     * @return
+     * @return the size of the smallest compacted row
      */
     public long getMeanRowSize();
 

http://git-wip-us.apache.org/repos/asf/cassandra/blob/185e0250/src/java/org/apache/cassandra/db/Table.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/Table.java b/src/java/org/apache/cassandra/db/Table.java
index 22285be..a48a0ab 100644
--- a/src/java/org/apache/cassandra/db/Table.java
+++ b/src/java/org/apache/cassandra/db/Table.java
@@ -211,7 +211,7 @@ public class Table
 
     /**
      * @param clientSuppliedName may be null.
-     * @return
+     * @return the name of the snapshot
      */
     public static String getTimestampedSnapshotName(String clientSuppliedName)
     {

http://git-wip-us.apache.org/repos/asf/cassandra/blob/185e0250/src/java/org/apache/cassandra/hadoop/pig/CassandraStorage.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/hadoop/pig/CassandraStorage.java b/src/java/org/apache/cassandra/hadoop/pig/CassandraStorage.java
index 65d8f58..e96d15b 100644
--- a/src/java/org/apache/cassandra/hadoop/pig/CassandraStorage.java
+++ b/src/java/org/apache/cassandra/hadoop/pig/CassandraStorage.java
@@ -105,7 +105,7 @@ public class CassandraStorage extends LoadFunc implements StoreFuncInterface, Lo
     }
 
     /**
-     * @param limit: number of columns to fetch in a slice
+     * @param limit number of columns to fetch in a slice
      */
     public CassandraStorage(int limit)
     {

http://git-wip-us.apache.org/repos/asf/cassandra/blob/185e0250/src/java/org/apache/cassandra/service/CassandraDaemon.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/service/CassandraDaemon.java b/src/java/org/apache/cassandra/service/CassandraDaemon.java
index b316d16..bb67a5a 100644
--- a/src/java/org/apache/cassandra/service/CassandraDaemon.java
+++ b/src/java/org/apache/cassandra/service/CassandraDaemon.java
@@ -43,8 +43,7 @@ public interface CassandraDaemon
     
     /**
      * Start the Cassandra Daemon, assuming that it has already been
-     * initialized, via either {@link CassandraDaemon#init(String[])} or
-     * {@link #load(String[])}.
+     * initialized (via {@link CassandraDaemon#init(String[])})
      * 
      * @throws IOException
      */