crunch-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gr...@apache.org
Subject git commit: CRUNCH-445 Fix class-level javadoc in At, From, To
Date Wed, 16 Jul 2014 13:27:14 GMT
Repository: crunch
Updated Branches:
  refs/heads/master 5201256c2 -> 59263aaf2


CRUNCH-445 Fix class-level javadoc in At, From, To

Fix formatting of code examples in the At, From, and To classes
so that they are readable in HTML javadoc.


Project: http://git-wip-us.apache.org/repos/asf/crunch/repo
Commit: http://git-wip-us.apache.org/repos/asf/crunch/commit/59263aaf
Tree: http://git-wip-us.apache.org/repos/asf/crunch/tree/59263aaf
Diff: http://git-wip-us.apache.org/repos/asf/crunch/diff/59263aaf

Branch: refs/heads/master
Commit: 59263aaf26436ea3ab5ffe8976465c03d0522863
Parents: 5201256
Author: Gabriel Reid <greid@apache.org>
Authored: Wed Jul 16 15:24:08 2014 +0200
Committer: Gabriel Reid <greid@apache.org>
Committed: Wed Jul 16 15:26:45 2014 +0200

----------------------------------------------------------------------
 crunch-core/src/main/java/org/apache/crunch/io/At.java   | 11 ++++++-----
 crunch-core/src/main/java/org/apache/crunch/io/From.java | 10 ++++++----
 crunch-core/src/main/java/org/apache/crunch/io/To.java   |  8 +++++---
 3 files changed, 17 insertions(+), 12 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/crunch/blob/59263aaf/crunch-core/src/main/java/org/apache/crunch/io/At.java
----------------------------------------------------------------------
diff --git a/crunch-core/src/main/java/org/apache/crunch/io/At.java b/crunch-core/src/main/java/org/apache/crunch/io/At.java
index 9a8db2f..b29acff 100644
--- a/crunch-core/src/main/java/org/apache/crunch/io/At.java
+++ b/crunch-core/src/main/java/org/apache/crunch/io/At.java
@@ -19,7 +19,6 @@ package org.apache.crunch.io;
 
 import org.apache.avro.generic.GenericData;
 import org.apache.avro.specific.SpecificRecord;
-import org.apache.crunch.Source;
 import org.apache.crunch.SourceTarget;
 import org.apache.crunch.TableSourceTarget;
 import org.apache.crunch.io.avro.AvroFileSourceTarget;
@@ -43,8 +42,10 @@ import org.apache.hadoop.io.Writable;
  * storing intermediate outputs that need to be passed from one run of a MapReduce pipeline
to another run. The
  * {@code SourceTarget} object acts as both a {@code Source} and a {@Target}, which enables
it to provide this
  * functionality.
- * 
- * <code>
+ *
+ * <pre>
+ * {@code
+ *
  *   Pipeline pipeline = new MRPipeline(this.getClass());
  *   // Create our intermediate storage location
  *   SourceTarget<String> intermediate = At.textFile("/temptext");
@@ -59,8 +60,8 @@ import org.apache.hadoop.io.Writable;
  *   // from the first phase.
  *   PCollection<String> phase2Input = pipeline.read(intermediate);
  *   ...
- * </code>
- * </p>
+ * }
+ * </pre>
  * 
  * <p>The {@code SourceTarget} abstraction is useful when we care about reading the
intermediate
  * outputs of a pipeline as well as the final results.</p>

http://git-wip-us.apache.org/repos/asf/crunch/blob/59263aaf/crunch-core/src/main/java/org/apache/crunch/io/From.java
----------------------------------------------------------------------
diff --git a/crunch-core/src/main/java/org/apache/crunch/io/From.java b/crunch-core/src/main/java/org/apache/crunch/io/From.java
index 8c0ee3f..37f08a4 100644
--- a/crunch-core/src/main/java/org/apache/crunch/io/From.java
+++ b/crunch-core/src/main/java/org/apache/crunch/io/From.java
@@ -57,8 +57,10 @@ import org.apache.hadoop.mapreduce.lib.input.FileInputFormat;
  * 
  * <p>The {@code From} class is intended to provide a literate API for creating
  * Crunch pipelines from common input file types.
- * 
- * <code>
+ *
+ * <pre>
+ * {@code
+ *
  *   Pipeline pipeline = new MRPipeline(this.getClass());
  *   
  *   // Reference the lines of a text file by wrapping the TextInputFormat class.
@@ -77,8 +79,8 @@ import org.apache.hadoop.mapreduce.lib.input.FileInputFormat;
  *   // References the key-value pairs from a custom extension of FileInputFormat:
  *   PTable<KeyWritable, ValueWritable> custom = pipeline.read(From.formattedFile(
  *       "/custom", MyFileInputFormat.class, KeyWritable.class, ValueWritable.class));
- * </code>
- * </p>
+ * }
+ * </pre>
  */
 public class From {
 

http://git-wip-us.apache.org/repos/asf/crunch/blob/59263aaf/crunch-core/src/main/java/org/apache/crunch/io/To.java
----------------------------------------------------------------------
diff --git a/crunch-core/src/main/java/org/apache/crunch/io/To.java b/crunch-core/src/main/java/org/apache/crunch/io/To.java
index 3bc5412..73745a8 100644
--- a/crunch-core/src/main/java/org/apache/crunch/io/To.java
+++ b/crunch-core/src/main/java/org/apache/crunch/io/To.java
@@ -36,7 +36,9 @@ import org.apache.hadoop.mapreduce.lib.output.FileOutputFormat;
  * the convenience {@code write} method on {@code PCollection} and {@code PTable}
  * instances.
  * 
- * <code>
+ * <pre>
+ * {@code
+ *
  *   Pipeline pipeline = new MRPipeline(this.getClass());
  *   ...
  *   // Write a PCollection<String> to a text file:
@@ -54,8 +56,8 @@ import org.apache.hadoop.mapreduce.lib.output.FileOutputFormat;
  *   // Write a PTable to a custom FileOutputFormat:
  *   PTable<KeyWritable, ValueWritable> custom = ...;
  *   pipeline.write(custom, To.formattedFile("/custom", MyFileFormat.class));
- * </code>
- * </p>
+ * }
+ * </pre>
  */
 public class To {
 


Mime
View raw message