simple javadoc fixes

This commit is contained in:
Dave Brosius 2012-11-02 02:46:31 -04:00
parent 78d6f64f33
commit 998131635c
11 changed files with 664 additions and 662 deletions

View File

@ -311,7 +311,7 @@ struct IndexExpression {
}
/**
* @Deprecated: use a KeyRange with row_filter in get_range_slices instead
* @deprecated use a KeyRange with row_filter in get_range_slices instead
*/
struct IndexClause {
1: required list<IndexExpression> expressions,
@ -473,7 +473,7 @@ struct KsDef {
2: required string strategy_class,
3: optional map<string,string> strategy_options,
/** @deprecated, ignored */
/** @deprecated ignored */
4: optional i32 replication_factor,
5: required list<CfDef> cf_defs,
@ -602,7 +602,7 @@ service Cassandra {
/**
Returns the subset of columns specified in SlicePredicate for the rows matching the IndexClause
@Deprecated; use get_range_slices instead with range.row_filter specified
@deprecated use get_range_slices instead with range.row_filter specified
*/
list<KeySlice> get_indexed_slices(1:required ColumnParent column_parent,
2:required IndexClause index_clause,
@ -822,7 +822,7 @@ service Cassandra {
4:SchemaDisagreementException sde)
/**
* @Deprecated This is now a no-op. Please use the CQL3 specific methods instead.
* @deprecated This is now a no-op. Please use the CQL3 specific methods instead.
*/
void set_cql_version(1: required string version) throws (1:InvalidRequestException ire)
}

View File

@ -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

View File

@ -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)
{

View File

@ -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

View File

@ -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);

View File

@ -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
*/

View File

@ -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)
{

View File

@ -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>

View File

@ -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();

View File

@ -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)
{