accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ctubb...@apache.org
Subject [2/3] accumulo git commit: ACCUMULO-4165 Fix RFileWriter javadoc
Date Thu, 14 Jul 2016 19:19:51 GMT
ACCUMULO-4165 Fix RFileWriter javadoc

@code isn't very well defined for multi-line code blocks, and Eclipse
javadoc parser produces a warning. This fixes the warning by using @code
exclusively as an inline element, to avoid any ambiguity in javadoc
parsing.

Also improve code block formatting for readability and fix a typo.


Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo
Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/45ddd25b
Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/45ddd25b
Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/45ddd25b

Branch: refs/heads/master
Commit: 45ddd25b04a58535eddba7b3b699a0b5713e5068
Parents: d664254
Author: Christopher Tubbs <ctubbsii@apache.org>
Authored: Thu Jul 14 15:06:38 2016 -0400
Committer: Christopher Tubbs <ctubbsii@apache.org>
Committed: Thu Jul 14 15:16:16 2016 -0400

----------------------------------------------------------------------
 .../accumulo/core/client/rfile/RFileWriter.java | 26 ++++++++++----------
 1 file changed, 13 insertions(+), 13 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/accumulo/blob/45ddd25b/core/src/main/java/org/apache/accumulo/core/client/rfile/RFileWriter.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/accumulo/core/client/rfile/RFileWriter.java b/core/src/main/java/org/apache/accumulo/core/client/rfile/RFileWriter.java
index 1de3661..9995888 100644
--- a/core/src/main/java/org/apache/accumulo/core/client/rfile/RFileWriter.java
+++ b/core/src/main/java/org/apache/accumulo/core/client/rfile/RFileWriter.java
@@ -35,7 +35,7 @@ import org.apache.commons.collections.map.LRUMap;
 
 import com.google.common.base.Preconditions;
 
-//formatter was adding spaced that checkstyle did not like, so turned off formatter
+//formatter was adding spaces that checkstyle did not like, so turned off formatter
 //@formatter:off
 /**
  * This class provides an API for writing RFiles. It can be used to create file for bulk
import into Accumulo using
@@ -54,30 +54,30 @@ import com.google.common.base.Preconditions;
  * Below is an example of using RFileWriter
  *
  * <pre>
- * {@code
- *    Iterable<Entry<Key, Value>> localityGroup1Data = ...
- *    Iterable<Entry<Key, Value>> localityGroup2Data = ...
- *    Iterable<Entry<Key, Value>> defaultGroupData = ...
+ * <code>
+ *     {@code Iterable<Entry<Key, Value>>} localityGroup1Data = ...
+ *     {@code Iterable<Entry<Key, Value>>} localityGroup2Data = ...
+ *     {@code Iterable<Entry<Key, Value>>} defaultGroupData = ...
  *
- *     try(RFileWriter writer = RFile.newWriter().to(file).build()){
+ *     try(RFileWriter writer = RFile.newWriter().to(file).build()) {
  *
- *       //Start a locality group before appending data.
+ *       // Start a locality group before appending data.
  *       writer.startNewLocalityGroup("groupA", "columnFam1", "columnFam2");
- *       //Append data to the locality group that was started above.  Must append in sorted
order.
+ *       // Append data to the locality group that was started above. Must append in sorted
order.
  *       writer.append(localityGroup1Data);
  *
- *       //Add another locality group.
+ *       // Add another locality group.
  *       writer.startNewLocalityGroup("groupB", "columnFam3", "columnFam4");
  *       writer.append(localityGroup2Data);
  *
- *       //The default locality group must be started last.  The column families for the
default group do not need to be specified.
+ *       // The default locality group must be started last. The column families for the
default group do not need to be specified.
  *       writer.startDefaultLocalityGroup();
- *       //Data appended here can not contain any column families specified in previous locality
groups.
+ *       // Data appended here can not contain any column families specified in previous
locality groups.
  *       writer.append(defaultGroupData);
  *
- *       //This is a try-with-resources so the writer is closed here at the end of the code
block.
+ *       // This is a try-with-resources so the writer is closed here at the end of the code
block.
  *     }
- * }
+ * </code>
  * </pre>
  *
  * <p>


Mime
View raw message