Author: jbellis
Date: Sat Aug 20 02:05:28 2011
New Revision: 1159832
URL: http://svn.apache.org/viewvc?rev=1159832&view=rev
Log:
javadoc corrections
patch by dbrosius; reviewed by jbellis for CASSANDRA-3063
Modified:
cassandra/trunk/src/java/org/apache/cassandra/db/ColumnFamilyStore.java
cassandra/trunk/src/java/org/apache/cassandra/db/Table.java
cassandra/trunk/src/java/org/apache/cassandra/db/columniterator/SSTableSliceIterator.java
cassandra/trunk/src/java/org/apache/cassandra/db/context/CounterContext.java
cassandra/trunk/src/java/org/apache/cassandra/db/context/IContext.java
cassandra/trunk/src/java/org/apache/cassandra/db/marshal/AbstractType.java
cassandra/trunk/src/java/org/apache/cassandra/dht/IPartitioner.java
cassandra/trunk/src/java/org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.java
cassandra/trunk/src/java/org/apache/cassandra/locator/AbstractNetworkTopologySnitch.java
cassandra/trunk/src/java/org/apache/cassandra/net/MessagingService.java
cassandra/trunk/src/java/org/apache/cassandra/service/AntiEntropyService.java
cassandra/trunk/src/java/org/apache/cassandra/service/StorageServiceMBean.java
cassandra/trunk/src/java/org/apache/cassandra/utils/EstimatedHistogram.java
cassandra/trunk/src/java/org/apache/cassandra/utils/MerkleTree.java
Modified:
cassandra/trunk/src/java/org/apache/cassandra/db/ColumnFamilyStore.java
URL:
http://svn.apache.org/viewvc/cassandra/trunk/src/java/org/apache/cassandra/db/ColumnFamilyStore.java?rev=1159832&r1=1159831&r2=1159832&view=diff
==============================================================================
--- cassandra/trunk/src/java/org/apache/cassandra/db/ColumnFamilyStore.java
(original)
+++ cassandra/trunk/src/java/org/apache/cassandra/db/ColumnFamilyStore.java Sat
Aug 20 02:05:28 2011
@@ -343,7 +343,6 @@ public class ColumnFamilyStore implement
/**
* Removes unnecessary files from the cf directory at startup: these
include temp files, orphans, zero-length files
* and compacted sstables. Files that cannot be recognized will be ignored.
- * @return A list of Descriptors that were removed.
*/
public static void scrubDataDirectories(String table, String columnFamily)
{
Modified: cassandra/trunk/src/java/org/apache/cassandra/db/Table.java
URL:
http://svn.apache.org/viewvc/cassandra/trunk/src/java/org/apache/cassandra/db/Table.java?rev=1159832&r1=1159831&r2=1159832&view=diff
==============================================================================
--- cassandra/trunk/src/java/org/apache/cassandra/db/Table.java (original)
+++ cassandra/trunk/src/java/org/apache/cassandra/db/Table.java Sat Aug 20
02:05:28 2011
@@ -43,12 +43,9 @@ import org.apache.cassandra.config.Confi
import org.apache.cassandra.config.DatabaseDescriptor;
import org.apache.cassandra.config.KSMetaData;
import org.apache.cassandra.db.commitlog.CommitLog;
-import org.apache.cassandra.db.compaction.CompactionInfo;
-import org.apache.cassandra.db.compaction.CompactionType;
import org.apache.cassandra.db.filter.QueryFilter;
import org.apache.cassandra.db.filter.QueryPath;
import org.apache.cassandra.db.index.SecondaryIndex;
-import org.apache.cassandra.io.sstable.ReducingKeyIterator;
import org.apache.cassandra.io.sstable.SSTableDeletingTask;
import org.apache.cassandra.io.sstable.SSTableReader;
import org.apache.cassandra.io.util.FileUtils;
@@ -213,7 +210,7 @@ public class Table
}
/**
- * @param clientSuppliedName; may be null.
+ * @param clientSuppliedName may be null.
* @return
*/
public static String getTimestampedSnapshotName(String clientSuppliedName)
Modified:
cassandra/trunk/src/java/org/apache/cassandra/db/columniterator/SSTableSliceIterator.java
URL:
http://svn.apache.org/viewvc/cassandra/trunk/src/java/org/apache/cassandra/db/columniterator/SSTableSliceIterator.java?rev=1159832&r1=1159831&r2=1159832&view=diff
==============================================================================
---
cassandra/trunk/src/java/org/apache/cassandra/db/columniterator/SSTableSliceIterator.java
(original)
+++
cassandra/trunk/src/java/org/apache/cassandra/db/columniterator/SSTableSliceIterator.java
Sat Aug 20 02:05:28 2011
@@ -25,7 +25,6 @@ import java.io.IOError;
import java.io.IOException;
import java.nio.ByteBuffer;
-import org.apache.cassandra.config.CFMetaData;
import org.apache.cassandra.config.DatabaseDescriptor;
import org.apache.cassandra.db.ColumnFamily;
import org.apache.cassandra.db.DecoratedKey;
@@ -69,7 +68,7 @@ public class SSTableSliceIterator implem
/**
* An iterator for a slice within an SSTable
- * @param metadata Metadata for the CFS we are reading from
+ * @param sstable Table for the CFS we are reading from
* @param file Optional parameter that input is read from. If null is
passed, this class creates an appropriate one automatically.
* If this class creates, it will close the underlying file when #close()
is called.
* 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)
Modified:
cassandra/trunk/src/java/org/apache/cassandra/db/context/CounterContext.java
URL:
http://svn.apache.org/viewvc/cassandra/trunk/src/java/org/apache/cassandra/db/context/CounterContext.java?rev=1159832&r1=1159831&r2=1159832&view=diff
==============================================================================
---
cassandra/trunk/src/java/org/apache/cassandra/db/context/CounterContext.java
(original)
+++
cassandra/trunk/src/java/org/apache/cassandra/db/context/CounterContext.java
Sat Aug 20 02:05:28 2011
@@ -425,7 +425,7 @@ public class CounterContext implements I
* Returns the aggregated count across all node ids.
*
* @param context a counter context
- * @terurn the aggregated count represented by {@code context}
+ * @return the aggregated count represented by {@code context}
*/
public long total(ByteBuffer context)
{
Modified: cassandra/trunk/src/java/org/apache/cassandra/db/context/IContext.java
URL:
http://svn.apache.org/viewvc/cassandra/trunk/src/java/org/apache/cassandra/db/context/IContext.java?rev=1159832&r1=1159831&r2=1159832&view=diff
==============================================================================
--- cassandra/trunk/src/java/org/apache/cassandra/db/context/IContext.java
(original)
+++ cassandra/trunk/src/java/org/apache/cassandra/db/context/IContext.java Sat
Aug 20 02:05:28 2011
@@ -55,8 +55,6 @@ public interface IContext
/**
* Return a context w/ an aggregated count for each node id.
*
- * @param allocator
- * An allocator for the merged value.
* @param left
* context.
* @param right
Modified:
cassandra/trunk/src/java/org/apache/cassandra/db/marshal/AbstractType.java
URL:
http://svn.apache.org/viewvc/cassandra/trunk/src/java/org/apache/cassandra/db/marshal/AbstractType.java?rev=1159832&r1=1159831&r2=1159832&view=diff
==============================================================================
--- cassandra/trunk/src/java/org/apache/cassandra/db/marshal/AbstractType.java
(original)
+++ cassandra/trunk/src/java/org/apache/cassandra/db/marshal/AbstractType.java
Sat Aug 20 02:05:28 2011
@@ -114,7 +114,7 @@ public abstract class AbstractType<T> im
/* validate that the byte array is a valid sequence for the type we are
supposed to be comparing */
public abstract void validate(ByteBuffer bytes) throws MarshalException;
- /** @deprecated; use reverseComparator field instead */
+ /** @deprecated use reverseComparator field instead */
public Comparator<ByteBuffer> getReverseComparator()
{
return reverseComparator;
Modified: cassandra/trunk/src/java/org/apache/cassandra/dht/IPartitioner.java
URL:
http://svn.apache.org/viewvc/cassandra/trunk/src/java/org/apache/cassandra/dht/IPartitioner.java?rev=1159832&r1=1159831&r2=1159832&view=diff
==============================================================================
--- cassandra/trunk/src/java/org/apache/cassandra/dht/IPartitioner.java
(original)
+++ cassandra/trunk/src/java/org/apache/cassandra/dht/IPartitioner.java Sat Aug
20 02:05:28 2011
@@ -27,7 +27,7 @@ import org.apache.cassandra.db.Decorated
public interface IPartitioner<T extends Token>
{
/**
- * @Deprecated: Used by SSTables before version 'e'.
+ * @deprecated Used by SSTables before version 'e'.
*
* Convert the on disk representation to a DecoratedKey object
* @param key On disk representation
Modified:
cassandra/trunk/src/java/org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.java
URL:
http://svn.apache.org/viewvc/cassandra/trunk/src/java/org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.java?rev=1159832&r1=1159831&r2=1159832&view=diff
==============================================================================
---
cassandra/trunk/src/java/org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.java
(original)
+++
cassandra/trunk/src/java/org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.java
Sat Aug 20 02:05:28 2011
@@ -27,9 +27,7 @@ import java.util.Set;
import org.apache.cassandra.config.CFMetaData;
import org.apache.cassandra.db.*;
-import org.apache.cassandra.db.commitlog.ReplayPosition;
import org.apache.cassandra.db.context.CounterContext;
-import org.apache.cassandra.db.marshal.AbstractType;
import org.apache.cassandra.service.StorageService;
import org.apache.cassandra.utils.NodeId;
import org.apache.cassandra.utils.Pair;
@@ -136,7 +134,7 @@ public abstract class AbstractSSTableSim
* @param value the column value
* @param timestamp the column timestamp
* @param ttl the column time to live in seconds
- * @param expirationTimestamp the local expiration timestamp in
milliseconds. This is the server time timestamp used for actually
+ * @param expirationTimestampMS the local expiration timestamp in
milliseconds. This is the server time timestamp used for actually
* expiring the column, and as a consequence should be synchronized with
the cassandra servers time. If {@code timestamp} represents
* the insertion time in microseconds (which is not required), this should
be {@code (timestamp / 1000) + (ttl * 1000)}.
*/
Modified:
cassandra/trunk/src/java/org/apache/cassandra/locator/AbstractNetworkTopologySnitch.java
URL:
http://svn.apache.org/viewvc/cassandra/trunk/src/java/org/apache/cassandra/locator/AbstractNetworkTopologySnitch.java?rev=1159832&r1=1159831&r2=1159832&view=diff
==============================================================================
---
cassandra/trunk/src/java/org/apache/cassandra/locator/AbstractNetworkTopologySnitch.java
(original)
+++
cassandra/trunk/src/java/org/apache/cassandra/locator/AbstractNetworkTopologySnitch.java
Sat Aug 20 02:05:28 2011
@@ -64,7 +64,6 @@ public abstract class AbstractNetworkTop
* Sorts the <tt>List</tt> of node addresses by proximity to the given
address
* @param address the address to sort the proximity by
* @param addresses the nodes to sort
- * @return the sorted <tt>List</tt>
*/
public void sortByProximity(final InetAddress address, List<InetAddress>
addresses)
{
Modified:
cassandra/trunk/src/java/org/apache/cassandra/net/MessagingService.java
URL:
http://svn.apache.org/viewvc/cassandra/trunk/src/java/org/apache/cassandra/net/MessagingService.java?rev=1159832&r1=1159831&r2=1159832&view=diff
==============================================================================
--- cassandra/trunk/src/java/org/apache/cassandra/net/MessagingService.java
(original)
+++ cassandra/trunk/src/java/org/apache/cassandra/net/MessagingService.java Sat
Aug 20 02:05:28 2011
@@ -48,7 +48,6 @@ import org.apache.cassandra.net.io.Seria
import org.apache.cassandra.net.sink.SinkManager;
import org.apache.cassandra.security.SSLFactory;
import org.apache.cassandra.security.streaming.SSLFileStreamTask;
-import org.apache.cassandra.service.ReadCallback;
import org.apache.cassandra.service.StorageService;
import org.apache.cassandra.streaming.FileStreamTask;
import org.apache.cassandra.streaming.StreamHeader;
@@ -160,8 +159,8 @@ public final class MessagingService impl
/**
* Track latency information for the dynamic snitch
- * @param cb: the callback associated with this message -- this lets us
know if it's a message type we're interested in
- * @param address: the host that replied to the message
+ * @param cb the callback associated with this message -- this lets us
know if it's a message type we're interested in
+ * @param address the host that replied to the message
* @param latency
*/
public void maybeAddLatency(IMessageCallback cb, InetAddress address,
double latency)
Modified:
cassandra/trunk/src/java/org/apache/cassandra/service/AntiEntropyService.java
URL:
http://svn.apache.org/viewvc/cassandra/trunk/src/java/org/apache/cassandra/service/AntiEntropyService.java?rev=1159832&r1=1159831&r2=1159832&view=diff
==============================================================================
---
cassandra/trunk/src/java/org/apache/cassandra/service/AntiEntropyService.java
(original)
+++
cassandra/trunk/src/java/org/apache/cassandra/service/AntiEntropyService.java
Sat Aug 20 02:05:28 2011
@@ -376,8 +376,6 @@ public class AntiEntropyService
/**
* Called after the validation lifecycle to respond with the now valid
tree. Runs in Stage.ANTIENTROPY.
- *
- * @return A meaningless object.
*/
public void run()
{
Modified:
cassandra/trunk/src/java/org/apache/cassandra/service/StorageServiceMBean.java
URL:
http://svn.apache.org/viewvc/cassandra/trunk/src/java/org/apache/cassandra/service/StorageServiceMBean.java?rev=1159832&r1=1159831&r2=1159832&view=diff
==============================================================================
---
cassandra/trunk/src/java/org/apache/cassandra/service/StorageServiceMBean.java
(original)
+++
cassandra/trunk/src/java/org/apache/cassandra/service/StorageServiceMBean.java
Sat Aug 20 02:05:28 2011
@@ -92,8 +92,8 @@ public interface StorageServiceMBean
public String[] getAllDataFileLocations();
/**
- * Get the list of data file locations for a given keyspace
- * @param keyspace the keyspace to get locatiosn for.
+ * Get the list of data file locations for a given table
+ * @param table the table to get locations for.
* @return String array of all locations
*/
public String[] getAllDataFileLocationsForTable(String table);
Modified:
cassandra/trunk/src/java/org/apache/cassandra/utils/EstimatedHistogram.java
URL:
http://svn.apache.org/viewvc/cassandra/trunk/src/java/org/apache/cassandra/utils/EstimatedHistogram.java?rev=1159832&r1=1159831&r2=1159832&view=diff
==============================================================================
--- cassandra/trunk/src/java/org/apache/cassandra/utils/EstimatedHistogram.java
(original)
+++ cassandra/trunk/src/java/org/apache/cassandra/utils/EstimatedHistogram.java
Sat Aug 20 02:05:28 2011
@@ -112,7 +112,7 @@ public class EstimatedHistogram
}
/**
- * @param reset: zero out buckets afterwards if true
+ * @param reset zero out buckets afterwards if true
* @return a long[] containing the current histogram buckets
*/
public long[] getBuckets(boolean reset)
Modified: cassandra/trunk/src/java/org/apache/cassandra/utils/MerkleTree.java
URL:
http://svn.apache.org/viewvc/cassandra/trunk/src/java/org/apache/cassandra/utils/MerkleTree.java?rev=1159832&r1=1159831&r2=1159832&view=diff
==============================================================================
--- cassandra/trunk/src/java/org/apache/cassandra/utils/MerkleTree.java
(original)
+++ cassandra/trunk/src/java/org/apache/cassandra/utils/MerkleTree.java Sat Aug
20 02:05:28 2011
@@ -476,8 +476,6 @@ public class MerkleTree implements Seria
/**
* Returns a lazy iterator of invalid TreeRanges that need to be filled
* in order to make the given Range valid.
- *
- * @param range The range to find invalid subranges for.
*/
public TreeRangeIterator invalids()
{
