You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cassandra.apache.org by db...@apache.org on 2016/01/01 19:56:53 UTC
cassandra git commit: fix some javadoc errors
Repository: cassandra
Updated Branches:
refs/heads/trunk 5f83f6c29 -> 6b7db8a53
fix some javadoc errors
Project: http://git-wip-us.apache.org/repos/asf/cassandra/repo
Commit: http://git-wip-us.apache.org/repos/asf/cassandra/commit/6b7db8a5
Tree: http://git-wip-us.apache.org/repos/asf/cassandra/tree/6b7db8a5
Diff: http://git-wip-us.apache.org/repos/asf/cassandra/diff/6b7db8a5
Branch: refs/heads/trunk
Commit: 6b7db8a534797d0ca7ebae506b265efd03e679ee
Parents: 5f83f6c
Author: Dave Brosius <db...@mebigfatguy.com>
Authored: Fri Jan 1 13:56:30 2016 -0500
Committer: Dave Brosius <db...@mebigfatguy.com>
Committed: Fri Jan 1 13:56:30 2016 -0500
----------------------------------------------------------------------
src/java/org/apache/cassandra/auth/CassandraRoleManager.java | 2 +-
src/java/org/apache/cassandra/auth/IRoleManager.java | 2 +-
src/java/org/apache/cassandra/auth/RoleOptions.java | 2 +-
src/java/org/apache/cassandra/auth/Roles.java | 2 +-
src/java/org/apache/cassandra/config/CFMetaData.java | 2 +-
src/java/org/apache/cassandra/config/ViewDefinition.java | 4 +++-
src/java/org/apache/cassandra/cql3/QueryOptions.java | 2 +-
src/java/org/apache/cassandra/cql3/SingleColumnRelation.java | 2 +-
src/java/org/apache/cassandra/db/CompactTables.java | 2 ++
src/java/org/apache/cassandra/db/LegacyLayout.java | 2 +-
src/java/org/apache/cassandra/db/RangeTombstoneList.java | 2 +-
src/java/org/apache/cassandra/db/commitlog/CommitLog.java | 2 +-
src/java/org/apache/cassandra/db/lifecycle/LogReplicaSet.java | 3 ++-
.../cassandra/db/rows/UnfilteredRowIteratorSerializer.java | 2 ++
src/java/org/apache/cassandra/db/rows/UnfilteredSerializer.java | 2 ++
src/java/org/apache/cassandra/db/view/View.java | 3 ++-
src/java/org/apache/cassandra/db/view/ViewUtils.java | 2 +-
src/java/org/apache/cassandra/dht/ExcludingBounds.java | 2 +-
src/java/org/apache/cassandra/dht/IncludingExcludingBounds.java | 2 +-
src/java/org/apache/cassandra/index/Index.java | 4 ++--
.../apache/cassandra/index/internal/CassandraIndexFunctions.java | 2 +-
.../index/internal/composites/ClusteringColumnIndex.java | 2 ++
.../apache/cassandra/index/transactions/CleanupTransaction.java | 2 +-
.../apache/cassandra/index/transactions/IndexTransaction.java | 2 +-
.../apache/cassandra/index/transactions/UpdateTransaction.java | 2 +-
.../org/apache/cassandra/io/sstable/format/SSTableReader.java | 2 +-
.../apache/cassandra/io/sstable/metadata/MetadataSerializer.java | 2 +-
src/java/org/apache/cassandra/service/StorageServiceMBean.java | 4 ++--
src/java/org/apache/cassandra/utils/FastByteOperations.java | 2 +-
src/java/org/apache/cassandra/utils/SearchIterator.java | 2 +-
src/java/org/apache/cassandra/utils/UUIDGen.java | 2 +-
31 files changed, 41 insertions(+), 29 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/auth/CassandraRoleManager.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/auth/CassandraRoleManager.java b/src/java/org/apache/cassandra/auth/CassandraRoleManager.java
index b34b648..826e89d 100644
--- a/src/java/org/apache/cassandra/auth/CassandraRoleManager.java
+++ b/src/java/org/apache/cassandra/auth/CassandraRoleManager.java
@@ -64,7 +64,7 @@ import org.mindrot.jbcrypt.BCrypt;
* in CREATE/ALTER ROLE statements.
*
* Such a configuration could be implemented using a custom IRoleManager that
- * extends CassandraRoleManager and which includes Option.PASSWORD in the Set<Option>
+ * extends CassandraRoleManager and which includes Option.PASSWORD in the {@code Set<Option>}
* returned from supportedOptions/alterableOptions. Any additional processing
* of the password itself (such as storing it in an alternative location) would
* be added in overridden createRole and alterRole implementations.
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/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 5afc7f3..b27681d 100644
--- a/src/java/org/apache/cassandra/auth/IRoleManager.java
+++ b/src/java/org/apache/cassandra/auth/IRoleManager.java
@@ -170,7 +170,7 @@ public interface IRoleManager
/**
* Where an implementation supports OPTIONS in CREATE and ALTER operations
- * this method should return the Map<String, String> representing the custom
+ * this method should return the {@code Map<String, String>} representing the custom
* options associated with the role, as supplied to CREATE or ALTER.
* It should never return null; if the implementation does not support
* OPTIONS or if none were supplied then it should return an empty map.
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/auth/RoleOptions.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/auth/RoleOptions.java b/src/java/org/apache/cassandra/auth/RoleOptions.java
index 9609ff3..1205d34 100644
--- a/src/java/org/apache/cassandra/auth/RoleOptions.java
+++ b/src/java/org/apache/cassandra/auth/RoleOptions.java
@@ -90,7 +90,7 @@ public class RoleOptions
}
/**
- * Return a Map<String, String> representing custom options
+ * Return a {@code Map<String, String>} representing custom options
* It is the responsiblity of IRoleManager implementations which support
* IRoleManager.Option.OPTION to handle type checking and conversion of these
* values, if present
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/auth/Roles.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/auth/Roles.java b/src/java/org/apache/cassandra/auth/Roles.java
index da6804b..854d1f2 100644
--- a/src/java/org/apache/cassandra/auth/Roles.java
+++ b/src/java/org/apache/cassandra/auth/Roles.java
@@ -28,7 +28,7 @@ public class Roles
/**
* Get all roles granted to the supplied Role, including both directly granted
* and inherited roles.
- * The returned roles may be cached if roles_validity_in_ms > 0
+ * The returned roles may be cached if {@code roles_validity_in_ms > 0}
*
* @param primaryRole the Role
* @return set of all granted Roles for the primary Role
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/config/CFMetaData.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/config/CFMetaData.java b/src/java/org/apache/cassandra/config/CFMetaData.java
index eee5ff6..128255c 100644
--- a/src/java/org/apache/cassandra/config/CFMetaData.java
+++ b/src/java/org/apache/cassandra/config/CFMetaData.java
@@ -419,7 +419,7 @@ public final class CFMetaData
/**
* Generates deterministic UUID from keyspace/columnfamily name pair.
- * This is used to generate the same UUID for C* version < 2.1
+ * This is used to generate the same UUID for {@code C* version < 2.1}
*
* Since 2.1, this is only used for system columnfamilies and tests.
*/
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/config/ViewDefinition.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/config/ViewDefinition.java b/src/java/org/apache/cassandra/config/ViewDefinition.java
index b29a8f9..89d69ee 100644
--- a/src/java/org/apache/cassandra/config/ViewDefinition.java
+++ b/src/java/org/apache/cassandra/config/ViewDefinition.java
@@ -129,8 +129,10 @@ public class ViewDefinition
}
/**
- * Replace the column {@param from} with {@param to} in this materialized view definition's partition,
+ * Replace the column 'from' with 'to' in this materialized view definition's partition,
* clustering, or included columns.
+ * @param from the existing column
+ * @param to the new column
*/
public void renameColumn(ColumnIdentifier from, ColumnIdentifier to)
{
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/cql3/QueryOptions.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/cql3/QueryOptions.java b/src/java/org/apache/cassandra/cql3/QueryOptions.java
index 6324911..e6cda89 100644
--- a/src/java/org/apache/cassandra/cql3/QueryOptions.java
+++ b/src/java/org/apache/cassandra/cql3/QueryOptions.java
@@ -152,7 +152,7 @@ public abstract class QueryOptions
throw new UnsupportedOperationException();
}
- /** The pageSize for this query. Will be <= 0 if not relevant for the query. */
+ /** The pageSize for this query. Will be {@code <= 0} if not relevant for the query. */
public int getPageSize()
{
return getSpecificOptions().pageSize;
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/cql3/SingleColumnRelation.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/cql3/SingleColumnRelation.java b/src/java/org/apache/cassandra/cql3/SingleColumnRelation.java
index e2c0b79..867a919 100644
--- a/src/java/org/apache/cassandra/cql3/SingleColumnRelation.java
+++ b/src/java/org/apache/cassandra/cql3/SingleColumnRelation.java
@@ -37,7 +37,7 @@ import static org.apache.cassandra.cql3.statements.RequestValidations.checkTrue;
/**
* Relations encapsulate the relationship between an entity of some kind, and
- * a value (term). For example, <key> > "start" or "colname1" = "somevalue".
+ * a value (term). For example, {@code <key> > "start" or "colname1" = "somevalue"}.
*
*/
public final class SingleColumnRelation extends Relation
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/db/CompactTables.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/CompactTables.java b/src/java/org/apache/cassandra/db/CompactTables.java
index a72e7f2..e3f3b16 100644
--- a/src/java/org/apache/cassandra/db/CompactTables.java
+++ b/src/java/org/apache/cassandra/db/CompactTables.java
@@ -56,6 +56,7 @@ import org.apache.cassandra.utils.ByteBufferUtil;
*
* As far as thrift is concerned, one exception to this is super column families, which have a different layout. Namely, a super
* column families is encoded with:
+ * {@code
* CREATE TABLE super (
* key [key_validation_class],
* super_column_name [comparator],
@@ -65,6 +66,7 @@ import org.apache.cassandra.utils.ByteBufferUtil;
* "" map<[sub_comparator], [default_validation_class]>
* PRIMARY KEY (key, super_column_name)
* )
+ * }
* In other words, every super column is encoded by a row. That row has one column for each defined "column_metadata", but it also
* has a special map column (whose name is the empty string as this is guaranteed to never conflict with a user-defined
* "column_metadata") which stores the super column "dynamic" sub-columns.
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/db/LegacyLayout.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/LegacyLayout.java b/src/java/org/apache/cassandra/db/LegacyLayout.java
index 95bf0e5..59db520 100644
--- a/src/java/org/apache/cassandra/db/LegacyLayout.java
+++ b/src/java/org/apache/cassandra/db/LegacyLayout.java
@@ -1729,7 +1729,7 @@ public abstract class LegacyLayout
/**
* Almost an entire copy of RangeTombstoneList from C* 2.1. The main difference is that LegacyBoundComparator
- * is used in place of Comparator<Composite> (because Composite doesn't exist any more).
+ * is used in place of {@code Comparator<Composite>} (because Composite doesn't exist any more).
*
* This class is needed to allow us to convert single-row deletions and complex deletions into range tombstones
* and properly merge them into the normal set of range tombstones.
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/db/RangeTombstoneList.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/RangeTombstoneList.java b/src/java/org/apache/cassandra/db/RangeTombstoneList.java
index 9a09e35..baeb227 100644
--- a/src/java/org/apache/cassandra/db/RangeTombstoneList.java
+++ b/src/java/org/apache/cassandra/db/RangeTombstoneList.java
@@ -38,7 +38,7 @@ import org.apache.cassandra.utils.memory.AbstractAllocator;
* A range tombstone has 4 elements: the start and end of the range covered,
* and the deletion infos (markedAt timestamp and local deletion time). The
* markedAt timestamp is what define the priority of 2 overlapping tombstones.
- * That is, given 2 tombstones [0, 10]@t1 and [5, 15]@t2, then if t2 > t1 (and
+ * That is, given 2 tombstones {@code [0, 10]@t1 and [5, 15]@t2, then if t2 > t1} (and
* are the tombstones markedAt values), the 2nd tombstone take precedence over
* the first one on [5, 10]. If such tombstones are added to a RangeTombstoneList,
* the range tombstone list will store them as [[0, 5]@t1, [5, 15]@t2].
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/db/commitlog/CommitLog.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/commitlog/CommitLog.java b/src/java/org/apache/cassandra/db/commitlog/CommitLog.java
index 851c84e..64e22e0 100644
--- a/src/java/org/apache/cassandra/db/commitlog/CommitLog.java
+++ b/src/java/org/apache/cassandra/db/commitlog/CommitLog.java
@@ -201,7 +201,7 @@ public class CommitLog implements CommitLogMBean
}
/**
- * @return a ReplayPosition which, if >= one returned from add(), implies add() was started
+ * @return a ReplayPosition which, if {@code >= one} returned from add(), implies add() was started
* (but not necessarily finished) prior to this call
*/
public ReplayPosition getContext()
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/db/lifecycle/LogReplicaSet.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/lifecycle/LogReplicaSet.java b/src/java/org/apache/cassandra/db/lifecycle/LogReplicaSet.java
index d9d9213..c557bf2 100644
--- a/src/java/org/apache/cassandra/db/lifecycle/LogReplicaSet.java
+++ b/src/java/org/apache/cassandra/db/lifecycle/LogReplicaSet.java
@@ -39,7 +39,8 @@ import org.apache.cassandra.utils.Throwables;
* A set of log replicas. This class mostly iterates over replicas when writing or reading,
* ensuring consistency among them and hiding replication details from LogFile.
*
- * @see LogReplica, LogFile
+ * @see LogReplica
+ * @see LogFile
*/
public class LogReplicaSet
{
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/db/rows/UnfilteredRowIteratorSerializer.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/rows/UnfilteredRowIteratorSerializer.java b/src/java/org/apache/cassandra/db/rows/UnfilteredRowIteratorSerializer.java
index 932ca4c..542f0a2 100644
--- a/src/java/org/apache/cassandra/db/rows/UnfilteredRowIteratorSerializer.java
+++ b/src/java/org/apache/cassandra/db/rows/UnfilteredRowIteratorSerializer.java
@@ -36,6 +36,7 @@ import org.apache.cassandra.utils.ByteBufferUtil;
* The serialization is composed of a header, follows by the rows and range tombstones of the iterator serialized
* until we read the end of the partition (see UnfilteredSerializer for details). The header itself
* is:
+ * {@code
* <cfid><key><flags><s_header>[<partition_deletion>][<static_row>][<row_estimate>]
* where:
* <cfid> is the table cfid.
@@ -54,6 +55,7 @@ import org.apache.cassandra.utils.ByteBufferUtil;
* <static_row> is the static row for this partition as serialized by UnfilteredSerializer.
* <row_estimate> is the (potentially estimated) number of rows serialized. This is only used for
* the purpose of sizing on the receiving end and should not be relied upon too strongly.
+ * }
*
* Please note that the format described above is the on-wire format. On-disk, the format is basically the
* same, but the header is written once per sstable, not once per-partition. Further, the actual row and
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/db/rows/UnfilteredSerializer.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/rows/UnfilteredSerializer.java b/src/java/org/apache/cassandra/db/rows/UnfilteredSerializer.java
index 4efc5eb..0451161 100644
--- a/src/java/org/apache/cassandra/db/rows/UnfilteredSerializer.java
+++ b/src/java/org/apache/cassandra/db/rows/UnfilteredSerializer.java
@@ -29,6 +29,7 @@ import org.apache.cassandra.io.util.DataOutputPlus;
/**
* Serialize/deserialize a single Unfiltered (both on-wire and on-disk).
*
+ * {@code
* The encoded format for an unfiltered is <flags>(<row>|<marker>) where:
*
* <flags> is a byte (or two) whose bits are flags used by the rest of the serialization. Each
@@ -66,6 +67,7 @@ import org.apache.cassandra.io.util.DataOutputPlus;
* and if it's expiring a delta-encoded int <ttl> (unless it's an expiring cell
* and the ttl and localDeletionTime are indicated by the flags to be the same
* than the row ones, in which case none of those appears).
+ * }
*/
public class UnfilteredSerializer
{
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/db/view/View.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/view/View.java b/src/java/org/apache/cassandra/db/view/View.java
index 5ff6c32..1deb055 100644
--- a/src/java/org/apache/cassandra/db/view/View.java
+++ b/src/java/org/apache/cassandra/db/view/View.java
@@ -191,7 +191,8 @@ public class View
* If the update contains any range tombstones, there is a possibility that it will not touch a range that is
* currently included in the view.
*
- * @return true if {@param partition} modifies a column included in the view
+ * @param partition the update partition
+ * @return true if partition modifies a column included in the view
*/
public boolean updateAffectsView(AbstractBTreePartition partition)
{
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/db/view/ViewUtils.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/db/view/ViewUtils.java b/src/java/org/apache/cassandra/db/view/ViewUtils.java
index 4d9517f..4dc1766 100644
--- a/src/java/org/apache/cassandra/db/view/ViewUtils.java
+++ b/src/java/org/apache/cassandra/db/view/ViewUtils.java
@@ -45,7 +45,7 @@ public final class ViewUtils
* nodes in the local datacenter when calculating cardinality.
*
* For example, if we have the following ring:
- * A, T1 -> B, T2 -> C, T3 -> A
+ * {@code A, T1 -> B, T2 -> C, T3 -> A}
*
* For the token T1, at RF=1, A would be included, so A's cardinality for T1 is 1. For the token T1, at RF=2, B would
* be included, so B's cardinality for token T1 is 2. For token T3, at RF = 2, A would be included, so A's cardinality
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/dht/ExcludingBounds.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/dht/ExcludingBounds.java b/src/java/org/apache/cassandra/dht/ExcludingBounds.java
index 8fbde28..ed6c2fc 100644
--- a/src/java/org/apache/cassandra/dht/ExcludingBounds.java
+++ b/src/java/org/apache/cassandra/dht/ExcludingBounds.java
@@ -23,7 +23,7 @@ import java.util.List;
import org.apache.cassandra.utils.Pair;
/**
- * AbstractBounds containing neither of its endpoints: (left, right). Used by CQL key > X AND key < Y range scans.
+ * AbstractBounds containing neither of its endpoints: (left, right). Used by {@code CQL key > X AND key < Y} range scans.
*/
public class ExcludingBounds<T extends RingPosition<T>> extends AbstractBounds<T>
{
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/dht/IncludingExcludingBounds.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/dht/IncludingExcludingBounds.java b/src/java/org/apache/cassandra/dht/IncludingExcludingBounds.java
index 19c098e..ac5185f 100644
--- a/src/java/org/apache/cassandra/dht/IncludingExcludingBounds.java
+++ b/src/java/org/apache/cassandra/dht/IncludingExcludingBounds.java
@@ -23,7 +23,7 @@ import java.util.List;
import org.apache.cassandra.utils.Pair;
/**
- * AbstractBounds containing only its left endpoint: [left, right). Used by CQL key >= X AND key < Y range scans.
+ * AbstractBounds containing only its left endpoint: [left, right). Used by {@code CQL key >= X AND key < Y} range scans.
*/
public class IncludingExcludingBounds<T extends RingPosition<T>> extends AbstractBounds<T>
{
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/index/Index.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/index/Index.java b/src/java/org/apache/cassandra/index/Index.java
index 3aadce9..d2dc350 100644
--- a/src/java/org/apache/cassandra/index/Index.java
+++ b/src/java/org/apache/cassandra/index/Index.java
@@ -232,7 +232,7 @@ public interface Index
* false enables the index implementation (or some other component) to control if and when SSTable data is
* incorporated into the index.
*
- * This is called by SecondaryIndexManager in buildIndexBlocking, buildAllIndexesBlocking & rebuildIndexesBlocking
+ * This is called by SecondaryIndexManager in buildIndexBlocking, buildAllIndexesBlocking and rebuildIndexesBlocking
* where a return value of false causes the index to be exluded from the set of those which will process the
* SSTable data.
* @return if the index should be included in the set which processes SSTable data, false otherwise.
@@ -466,7 +466,7 @@ public interface Index
* See CASSANDRA-8717 for further discussion.
*
* The function takes a PartitionIterator of the results from the replicas which has already been collated
- * & reconciled, along with the command being executed. It returns another PartitionIterator containing the results
+ * and reconciled, along with the command being executed. It returns another PartitionIterator containing the results
* of the transformation (which may be the same as the input if the transformation is a no-op).
*/
public BiFunction<PartitionIterator, ReadCommand, PartitionIterator> postProcessorFor(ReadCommand command);
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/index/internal/CassandraIndexFunctions.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/index/internal/CassandraIndexFunctions.java b/src/java/org/apache/cassandra/index/internal/CassandraIndexFunctions.java
index b7cb3a2..89eebdf 100644
--- a/src/java/org/apache/cassandra/index/internal/CassandraIndexFunctions.java
+++ b/src/java/org/apache/cassandra/index/internal/CassandraIndexFunctions.java
@@ -54,7 +54,7 @@ public interface CassandraIndexFunctions
/**
* Add the clustering columns for a specific type of index table to the a CFMetaData.Builder (which is being
* used to construct the index table's CFMetadata. In the default implementation, the clustering columns of the
- * index table hold the partition key & clustering columns of the base table. This is overridden in several cases:
+ * index table hold the partition key and clustering columns of the base table. This is overridden in several cases:
* * When the indexed value is itself a clustering column, in which case, we only need store the base table's
* *other* clustering values in the index - the indexed value being the index table's partition key
* * When the indexed value is a collection value, in which case we also need to capture the cell path from the base
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/index/internal/composites/ClusteringColumnIndex.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/index/internal/composites/ClusteringColumnIndex.java b/src/java/org/apache/cassandra/index/internal/composites/ClusteringColumnIndex.java
index b932602..f207e9b 100644
--- a/src/java/org/apache/cassandra/index/internal/composites/ClusteringColumnIndex.java
+++ b/src/java/org/apache/cassandra/index/internal/composites/ClusteringColumnIndex.java
@@ -36,12 +36,14 @@ import org.apache.cassandra.schema.IndexMetadata;
* has no impact) and v the cell value.
*
* Such a cell is always indexed by this index (or rather, it is indexed if
+ * {@code
* n >= columnDef.componentIndex, which will always be the case in practice)
* and it will generate (makeIndexColumnName()) an index entry whose:
* - row key will be ck_i (getIndexedValue()) where i == columnDef.componentIndex.
* - cell name will
* rk ck_0 ... ck_{i-1} ck_{i+1} ck_n
* where rk is the row key of the initial cell and i == columnDef.componentIndex.
+ * }
*/
public class ClusteringColumnIndex extends CassandraIndex
{
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/index/transactions/CleanupTransaction.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/index/transactions/CleanupTransaction.java b/src/java/org/apache/cassandra/index/transactions/CleanupTransaction.java
index 1d6ba56..29ee14c 100644
--- a/src/java/org/apache/cassandra/index/transactions/CleanupTransaction.java
+++ b/src/java/org/apache/cassandra/index/transactions/CleanupTransaction.java
@@ -26,7 +26,7 @@ import org.apache.cassandra.db.rows.Row;
*
* Notifies registered indexers of each partition being removed and
*
- * Compaction & Cleanup are somewhat simpler than dealing with incoming writes,
+ * Compaction and Cleanup are somewhat simpler than dealing with incoming writes,
* being only concerned with cleaning up stale index entries.
*
* When multiple versions of a row are compacted, the CleanupTransaction is
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/index/transactions/IndexTransaction.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/index/transactions/IndexTransaction.java b/src/java/org/apache/cassandra/index/transactions/IndexTransaction.java
index 3fb8235..3d4b7e2 100644
--- a/src/java/org/apache/cassandra/index/transactions/IndexTransaction.java
+++ b/src/java/org/apache/cassandra/index/transactions/IndexTransaction.java
@@ -26,7 +26,7 @@ package org.apache.cassandra.index.transactions;
* Used on the regular write path and when indexing newly acquired SSTables from streaming or sideloading. This type
* of transaction may include both row inserts and updates to rows previously existing in the base Memtable. Instances
* are scoped to a single partition update and are obtained from the factory method
- * @{code SecondaryIndexManager#newUpdateTransaction}
+ * {@code SecondaryIndexManager#newUpdateTransaction}
*
* * {@code CompactionTransaction}
* Used during compaction when stale entries which have been superceded are cleaned up from the index. As rows in a
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/index/transactions/UpdateTransaction.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/index/transactions/UpdateTransaction.java b/src/java/org/apache/cassandra/index/transactions/UpdateTransaction.java
index c78304a..51533c2 100644
--- a/src/java/org/apache/cassandra/index/transactions/UpdateTransaction.java
+++ b/src/java/org/apache/cassandra/index/transactions/UpdateTransaction.java
@@ -53,7 +53,7 @@ import org.apache.cassandra.db.rows.Row;
* onInserted(row)* -- called for each Row not already present in the Memtable
* onUpdated(existing, updated)* -- called for any Row in the update for where a version was already present
* in the Memtable. It's important to note here that existing is the previous
- * row from the Memtable & updated is the final version replacing it. It is
+ * row from the Memtable and updated is the final version replacing it. It is
* *not* the incoming row, but the result of merging the incoming and existing
* rows.
* commit() -- finally, finish is called when the new Partition is swapped into the Memtable
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/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 c63e52d..c38169c 100644
--- a/src/java/org/apache/cassandra/io/sstable/format/SSTableReader.java
+++ b/src/java/org/apache/cassandra/io/sstable/format/SSTableReader.java
@@ -1253,7 +1253,7 @@ public abstract class SSTableReader extends SSTable implements SelfRefCounted<SS
/**
* Gets the position in the index file to start scanning to find the given key (at most indexInterval keys away,
- * modulo downsampling of the index summary). Always returns a value >= 0
+ * modulo downsampling of the index summary). Always returns a {@code value >= 0}
*/
public long getIndexScanPosition(PartitionPosition key)
{
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/io/sstable/metadata/MetadataSerializer.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/io/sstable/metadata/MetadataSerializer.java b/src/java/org/apache/cassandra/io/sstable/metadata/MetadataSerializer.java
index 635adcd..ae1787a 100644
--- a/src/java/org/apache/cassandra/io/sstable/metadata/MetadataSerializer.java
+++ b/src/java/org/apache/cassandra/io/sstable/metadata/MetadataSerializer.java
@@ -37,7 +37,7 @@ import org.apache.cassandra.io.util.RandomAccessReader;
import org.apache.cassandra.utils.FBUtilities;
/**
- * Metadata serializer for SSTables version >= 'k'.
+ * Metadata serializer for SSTables {@code version >= 'k'}.
*
* <pre>
* File format := | number of components (4 bytes) | toc | component1 | component2 | ... |
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/service/StorageServiceMBean.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/service/StorageServiceMBean.java b/src/java/org/apache/cassandra/service/StorageServiceMBean.java
index ae3889a..70691c7 100644
--- a/src/java/org/apache/cassandra/service/StorageServiceMBean.java
+++ b/src/java/org/apache/cassandra/service/StorageServiceMBean.java
@@ -384,7 +384,7 @@ public interface StorageServiceMBean extends NotificationEmitter
* If classQualifer is not empty but level is empty/null, it will set the level to null for the defined classQualifer<br>
* If level cannot be parsed, then the level will be defaulted to DEBUG<br>
* <br>
- * The logback configuration should have < jmxConfigurator /> set
+ * The logback configuration should have {@code < jmxConfigurator />} set
*
* @param classQualifier The logger's classQualifer
* @param level The log level
@@ -423,7 +423,7 @@ public interface StorageServiceMBean extends NotificationEmitter
/**
* given a list of tokens (representing the nodes in the cluster), returns
- * a mapping from "token -> %age of cluster owned by that token"
+ * a mapping from {@code "token -> %age of cluster owned by that token"}
*/
public Map<InetAddress, Float> getOwnership();
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/utils/FastByteOperations.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/utils/FastByteOperations.java b/src/java/org/apache/cassandra/utils/FastByteOperations.java
index f35d2e2..9e9bb6c 100644
--- a/src/java/org/apache/cassandra/utils/FastByteOperations.java
+++ b/src/java/org/apache/cassandra/utils/FastByteOperations.java
@@ -333,7 +333,7 @@ public class FastByteOperations
* @param memoryOffset2 Where to start comparing in the right buffer (pure memory address if buffer1 is null, or relative otherwise)
* @param length1 How much to compare from the left buffer
* @param length2 How much to compare from the right buffer
- * @return 0 if equal, < 0 if left is less than right, etc.
+ * @return 0 if equal, {@code < 0} if left is less than right, etc.
*/
@Inline
public static int compareTo(Object buffer1, long memoryOffset1, int length1,
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/utils/SearchIterator.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/utils/SearchIterator.java b/src/java/org/apache/cassandra/utils/SearchIterator.java
index 5309f4a..95cb33c 100644
--- a/src/java/org/apache/cassandra/utils/SearchIterator.java
+++ b/src/java/org/apache/cassandra/utils/SearchIterator.java
@@ -26,7 +26,7 @@ public interface SearchIterator<K, V>
* if this or any key greater has already been returned by the iterator, the method may
* choose to return null, the correct or incorrect output, or fail an assertion.
*
- * it is permitted to search past the end of the iterator, i.e. !hasNext() => next(?) == null
+ * it is permitted to search past the end of the iterator, i.e. {@code !hasNext() => next(?) == null}
*
* @param key to search for
* @return value associated with key, if present in direction of travel
http://git-wip-us.apache.org/repos/asf/cassandra/blob/6b7db8a5/src/java/org/apache/cassandra/utils/UUIDGen.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/utils/UUIDGen.java b/src/java/org/apache/cassandra/utils/UUIDGen.java
index f046279..105be0f 100644
--- a/src/java/org/apache/cassandra/utils/UUIDGen.java
+++ b/src/java/org/apache/cassandra/utils/UUIDGen.java
@@ -203,7 +203,7 @@ public class UUIDGen
* of a type 1 UUID (a time-based UUID).
*
* To specify a 100-nanoseconds precision timestamp, one should provide a milliseconds timestamp and
- * a number 0 <= n < 10000 such that n*100 is the number of nanoseconds within that millisecond.
+ * a number {@code 0 <= n < 10000} such that n*100 is the number of nanoseconds within that millisecond.
*
* <p><i><b>Warning:</b> This method is not guaranteed to return unique UUIDs; Multiple
* invocations using identical timestamps will result in identical UUIDs.</i></p>