cassandra-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dbros...@apache.org
Subject [3/3] simple javadoc fixes
Date Fri, 02 Nov 2012 06:47:17 GMT
http://git-wip-us.apache.org/repos/asf/cassandra/blob/99813163/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 9b18c23..39ed703 100644
--- a/src/java/org/apache/cassandra/db/ColumnFamilyStoreMBean.java
+++ b/src/java/org/apache/cassandra/db/ColumnFamilyStoreMBean.java
@@ -39,6 +39,7 @@ public interface ColumnFamilyStoreMBean
      *
      * @see org.apache.cassandra.metrics.ColumnFamilyMetrics#memtableDataSize
      * @return The size in bytes.
+     * @deprecated
      */
     @Deprecated
     public long getMemtableDataSize();
@@ -63,7 +64,7 @@ public interface ColumnFamilyStoreMBean
     public int getMemtableSwitchCount();
 
     /**
-     * @see org.apache.cassandra.metrics.ColumnFamilyMetrics#recentSSTablesPerReadHistogram
+     * @see org.apache.cassandra.metrics.ColumnFamilyMetrics#recentSSTablesPerRead
      * @return a histogram of the number of sstable data files accessed per read: reading
this property resets it
      */
     @Deprecated

http://git-wip-us.apache.org/repos/asf/cassandra/blob/99813163/src/java/org/apache/cassandra/db/columniterator/SSTableSliceIterator.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/columniterator/SSTableSliceIterator.java b/src/java/org/apache/cassandra/db/columniterator/SSTableSliceIterator.java
index bbd0f74..caa067d 100644
--- a/src/java/org/apache/cassandra/db/columniterator/SSTableSliceIterator.java
+++ b/src/java/org/apache/cassandra/db/columniterator/SSTableSliceIterator.java
@@ -52,9 +52,9 @@ public class SSTableSliceIterator implements ISSTableColumnIterator
      * If a caller passes a non-null argument, this class will NOT close the underlying file
when the iterator is closed (i.e. the caller is responsible for closing the file)
      * In all cases the caller should explicitly #close() this iterator.
      * @param key The key the requested slice resides under
-     * @param startColumn The start of the slice
-     * @param finishColumn The end of the slice
+     * @param slices the column slices
      * @param reversed Results are returned in reverse order iff reversed is true.
+     * @param indexEntry position of the row
      */
     public SSTableSliceIterator(SSTableReader sstable, FileDataInput file, DecoratedKey key,
ColumnSlice[] slices, boolean reversed, RowIndexEntry indexEntry)
     {

http://git-wip-us.apache.org/repos/asf/cassandra/blob/99813163/src/java/org/apache/cassandra/db/compaction/CompactionManagerMBean.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/compaction/CompactionManagerMBean.java b/src/java/org/apache/cassandra/db/compaction/CompactionManagerMBean.java
index 5f1a156..db44344 100644
--- a/src/java/org/apache/cassandra/db/compaction/CompactionManagerMBean.java
+++ b/src/java/org/apache/cassandra/db/compaction/CompactionManagerMBean.java
@@ -43,7 +43,7 @@ public interface CompactionManagerMBean
     public long getCompletedTasks();
 
     /**
-     * @see org.apache.cassandra.metrics.CompactionMetrics#totalBytesCompacted
+     * @see org.apache.cassandra.metrics.CompactionMetrics#bytesCompacted
      * @return total number of bytes compacted since server [re]start
      */
     @Deprecated

http://git-wip-us.apache.org/repos/asf/cassandra/blob/99813163/src/java/org/apache/cassandra/db/marshal/AbstractCompositeType.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/marshal/AbstractCompositeType.java b/src/java/org/apache/cassandra/db/marshal/AbstractCompositeType.java
index 12ecd9f..2aac62a 100644
--- a/src/java/org/apache/cassandra/db/marshal/AbstractCompositeType.java
+++ b/src/java/org/apache/cassandra/db/marshal/AbstractCompositeType.java
@@ -327,7 +327,8 @@ public abstract class AbstractCompositeType extends AbstractType<ByteBuffer>
 
     /**
      * @return the comparator for the given component. static CompositeType will consult
-     * @param i; DynamicCompositeType will read the type information from @param bb
+     * @param i DynamicCompositeType will read the type information from @param bb
+     * @param bb name of type definition
      */
     abstract protected AbstractType<?> getComparator(int i, ByteBuffer bb);
 

http://git-wip-us.apache.org/repos/asf/cassandra/blob/99813163/src/java/org/apache/cassandra/io/ISSTableSerializer.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/io/ISSTableSerializer.java b/src/java/org/apache/cassandra/io/ISSTableSerializer.java
index c2cefc6..0a6c9db 100644
--- a/src/java/org/apache/cassandra/io/ISSTableSerializer.java
+++ b/src/java/org/apache/cassandra/io/ISSTableSerializer.java
@@ -38,7 +38,7 @@ public interface ISSTableSerializer<T>
      * Deserialize into the specified DataInputStream instance in the format
      * suited for SSTables.
      * @param dis DataInput from which deserialization needs to happen.
-     * @param sstableVersion the version for the sstable we're reading from
+     * @param version the version for the sstable we're reading from
      * @throws IOException
      * @return the type that was deserialized
      */

http://git-wip-us.apache.org/repos/asf/cassandra/blob/99813163/src/java/org/apache/cassandra/locator/TokenMetadata.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/locator/TokenMetadata.java b/src/java/org/apache/cassandra/locator/TokenMetadata.java
index cee920c..3b5f86d 100644
--- a/src/java/org/apache/cassandra/locator/TokenMetadata.java
+++ b/src/java/org/apache/cassandra/locator/TokenMetadata.java
@@ -934,7 +934,7 @@ public class TokenMetadata
     }
 
     /**
-     * @Deprecated; retained for benefit of old tests
+     * @deprecated retained for benefit of old tests
      */
     public Collection<InetAddress> getWriteEndpoints(Token token, String table, Collection<InetAddress>
naturalEndpoints)
     {

http://git-wip-us.apache.org/repos/asf/cassandra/blob/99813163/src/java/org/apache/cassandra/service/EmbeddedCassandraService.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/service/EmbeddedCassandraService.java b/src/java/org/apache/cassandra/service/EmbeddedCassandraService.java
index 6e4dffa..659d851 100644
--- a/src/java/org/apache/cassandra/service/EmbeddedCassandraService.java
+++ b/src/java/org/apache/cassandra/service/EmbeddedCassandraService.java
@@ -27,7 +27,7 @@ import org.apache.cassandra.service.CassandraDaemon;
  * This kind of service is useful when running unit tests of
  * services using cassandra for example.
  *
- * See {@link EmbeddedCassandraServiceTest} for usage.
+ * See {@link org.apache.cassandra.service.EmbeddedCassandraServiceTest} for usage.
  * <p>
  * This is the implementation of https://issues.apache.org/jira/browse/CASSANDRA-740
  * <p>

http://git-wip-us.apache.org/repos/asf/cassandra/blob/99813163/src/java/org/apache/cassandra/service/StorageProxyMBean.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/service/StorageProxyMBean.java b/src/java/org/apache/cassandra/service/StorageProxyMBean.java
index c6d4b7c..1bbfd1f 100644
--- a/src/java/org/apache/cassandra/service/StorageProxyMBean.java
+++ b/src/java/org/apache/cassandra/service/StorageProxyMBean.java
@@ -20,27 +20,27 @@ package org.apache.cassandra.service;
 public interface StorageProxyMBean
 {
     /**
-     * @see org.apache.cassandra.metrics.LatencyMetrics#opCount
+     * @see org.apache.cassandra.metrics.LatencyMetrics#lastOpCount
      */
     @Deprecated
     public long getReadOperations();
     /**
-     * @see org.apache.cassandra.metrics.LatencyMetrics#totalLatency
+     * @see org.apache.cassandra.metrics.LatencyMetrics#totalLatencyHistogram
      */
     @Deprecated
     public long getTotalReadLatencyMicros();
     /**
-     * @see org.apache.cassandra.metrics.LatencyMetrics#recentLatencyMicro
+     * @see org.apache.cassandra.metrics.LatencyMetrics#recentLatencyHistogram
      */
     @Deprecated
     public double getRecentReadLatencyMicros();
     /**
-     * @see org.apache.cassandra.metrics.LatencyMetrics#totalLatencyHistogramMicro
+     * @see org.apache.cassandra.metrics.LatencyMetrics#totalLatencyHistogram
      */
     @Deprecated
     public long[] getTotalReadLatencyHistogramMicros();
     /**
-     * @see org.apache.cassandra.metrics.LatencyMetrics#recentLatencyHistogramMicro
+     * @see org.apache.cassandra.metrics.LatencyMetrics#recentLatencyHistogram
      */
     @Deprecated
     public long[] getRecentReadLatencyHistogramMicros();

http://git-wip-us.apache.org/repos/asf/cassandra/blob/99813163/src/java/org/apache/cassandra/service/StorageService.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/service/StorageService.java b/src/java/org/apache/cassandra/service/StorageService.java
index cfe6982..88abadb 100644
--- a/src/java/org/apache/cassandra/service/StorageService.java
+++ b/src/java/org/apache/cassandra/service/StorageService.java
@@ -922,7 +922,7 @@ public class StorageService implements IEndpointStateChangeSubscriber,
StorageSe
     /**
      * for a keyspace, return the ranges and corresponding listen addresses.
      * @param keyspace
-     * @return
+     * @return the endpoint map
      */
     public Map<List<String>, List<String>> getRangeToEndpointMap(String
keyspace)
     {
@@ -938,7 +938,7 @@ public class StorageService implements IEndpointStateChangeSubscriber,
StorageSe
     /**
      * Return the rpc address associated with an endpoint as a string.
      * @param endpoint The endpoint to get rpc address for
-     * @return
+     * @return the rpc address
      */
     public String getRpcaddress(InetAddress endpoint)
     {
@@ -953,7 +953,7 @@ public class StorageService implements IEndpointStateChangeSubscriber,
StorageSe
     /**
      * for a keyspace, return the ranges and corresponding RPC addresses for a given keyspace.
      * @param keyspace
-     * @return
+     * @return the endpoint map
      */
     public Map<List<String>, List<String>> getRangeToRpcaddressMap(String
keyspace)
     {


Mime
View raw message