Updated Branches: refs/heads/trunk f74d4c9cd -> 458ddd8f9
GIRAPH-512: JavaDoc warnings (emre.aladag via nitay) Project: http://git-wip-us.apache.org/repos/asf/giraph/repo Commit: http://git-wip-us.apache.org/repos/asf/giraph/commit/458ddd8f Tree: http://git-wip-us.apache.org/repos/asf/giraph/tree/458ddd8f Diff: http://git-wip-us.apache.org/repos/asf/giraph/diff/458ddd8f Branch: refs/heads/trunk Commit: 458ddd8f92d7dab8428c7bf481cd2797b05b278e Parents: f74d4c9 Author: Nitay Joffe <[email protected]> Authored: Wed May 22 16:52:57 2013 -0400 Committer: Nitay Joffe <[email protected]> Committed: Wed May 22 16:52:57 2013 -0400 ---------------------------------------------------------------------- CHANGELOG | 2 ++ .../giraph/bsp/CentralizedServiceMaster.java | 8 ++++---- .../comm/messages/SequentialFileMessageStore.java | 6 +++--- .../main/java/org/apache/giraph/io/EdgeReader.java | 4 ++-- .../giraph/io/formats/GiraphTextInputFormat.java | 6 +++--- ...DoubleDoubleAdjacencyListVertexInputFormat.java | 3 ++- ...DoubleDoubleAdjacencyListVertexInputFormat.java | 3 ++- .../org/apache/giraph/utils/YourKitContext.java | 4 ++-- .../org/apache/giraph/utils/YourKitProfiler.java | 2 +- ...xWithDoubleValueDoubleEdgeTextOutputFormat.java | 3 ++- .../io/hcatalog/HCatalogVertexInputFormat.java | 6 +++--- .../apache/giraph/hive/output/HiveRecordSaver.java | 2 +- 12 files changed, 27 insertions(+), 22 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/giraph/blob/458ddd8f/CHANGELOG ---------------------------------------------------------------------- diff --git a/CHANGELOG b/CHANGELOG index 968addb..66fdd69 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,6 +1,8 @@ Giraph Change Log Release 1.1.0 - unreleased + GIRAPH-512: JavaDoc warnings (emre.aladag via nitay) + GIRAPH-620: Website Documentation: How to use Hive I/O with Giraph (nitay) GIRAPH-667: Decouple Vertex data and Computation, make Computation http://git-wip-us.apache.org/repos/asf/giraph/blob/458ddd8f/giraph-core/src/main/java/org/apache/giraph/bsp/CentralizedServiceMaster.java ---------------------------------------------------------------------- diff --git a/giraph-core/src/main/java/org/apache/giraph/bsp/CentralizedServiceMaster.java b/giraph-core/src/main/java/org/apache/giraph/bsp/CentralizedServiceMaster.java index fb98b00..f41fc3d 100644 --- a/giraph-core/src/main/java/org/apache/giraph/bsp/CentralizedServiceMaster.java +++ b/giraph-core/src/main/java/org/apache/giraph/bsp/CentralizedServiceMaster.java @@ -57,8 +57,8 @@ public interface CentralizedServiceMaster<I extends WritableComparable, MasterInfo getMasterInfo(); /** - * Create the {@link InputSplit} objects from the index range based on the - * user-defined VertexInputFormat. The {@link InputSplit} objects will + * Create the {@link BspInputSplit} objects from the index range based on the + * user-defined VertexInputFormat. The {@link BspInputSplit} objects will * processed by the workers later on during the INPUT_SUPERSTEP. * * @return Number of splits. Returns -1 on failure to create @@ -67,8 +67,8 @@ public interface CentralizedServiceMaster<I extends WritableComparable, int createVertexInputSplits(); /** - * Create the {@link InputSplit} objects from the index range based on the - * user-defined EdgeInputFormat. The {@link InputSplit} objects will + * Create the {@link BspInputSplit} objects from the index range based on the + * user-defined EdgeInputFormat. The {@link BspInputSplit} objects will * processed by the workers later on during the INPUT_SUPERSTEP. * * @return Number of splits. Returns -1 on failure to create http://git-wip-us.apache.org/repos/asf/giraph/blob/458ddd8f/giraph-core/src/main/java/org/apache/giraph/comm/messages/SequentialFileMessageStore.java ---------------------------------------------------------------------- diff --git a/giraph-core/src/main/java/org/apache/giraph/comm/messages/SequentialFileMessageStore.java b/giraph-core/src/main/java/org/apache/giraph/comm/messages/SequentialFileMessageStore.java index f0a8f6d..23bbbc5 100644 --- a/giraph-core/src/main/java/org/apache/giraph/comm/messages/SequentialFileMessageStore.java +++ b/giraph-core/src/main/java/org/apache/giraph/comm/messages/SequentialFileMessageStore.java @@ -49,9 +49,9 @@ import java.util.concurrent.atomic.AtomicInteger; import static org.apache.giraph.conf.GiraphConstants.MESSAGES_DIRECTORY; /** - * Used for writing and reading collection of messages to the disk. {@link - * #addMessages(MessageStore<I, M>)} should be called only once with - * the messages we want to store. + * Used for writing and reading collection of messages to the disk. + * {@link SequentialFileMessageStore#addMessages(MessageStore)} + * should be called only once with the messages we want to store. * <p/> * It's optimized for retrieving messages in the natural order of vertex ids * they are sent to. http://git-wip-us.apache.org/repos/asf/giraph/blob/458ddd8f/giraph-core/src/main/java/org/apache/giraph/io/EdgeReader.java ---------------------------------------------------------------------- diff --git a/giraph-core/src/main/java/org/apache/giraph/io/EdgeReader.java b/giraph-core/src/main/java/org/apache/giraph/io/EdgeReader.java index a1af98f..363a5e6 100644 --- a/giraph-core/src/main/java/org/apache/giraph/io/EdgeReader.java +++ b/giraph-core/src/main/java/org/apache/giraph/io/EdgeReader.java @@ -27,8 +27,8 @@ import org.apache.hadoop.mapreduce.InputSplit; import org.apache.hadoop.mapreduce.TaskAttemptContext; /** - * Analogous to {@link RecordReader} for edges. Will read the edges - * from an input split. + * Analogous to {@link org.apache.giraph.bsp.BspRecordReader} for edges. + * Will read the edges from an input split. * * @param <I> Vertex id * @param <E> Edge data http://git-wip-us.apache.org/repos/asf/giraph/blob/458ddd8f/giraph-core/src/main/java/org/apache/giraph/io/formats/GiraphTextInputFormat.java ---------------------------------------------------------------------- diff --git a/giraph-core/src/main/java/org/apache/giraph/io/formats/GiraphTextInputFormat.java b/giraph-core/src/main/java/org/apache/giraph/io/formats/GiraphTextInputFormat.java index 978116d..37f70d0 100644 --- a/giraph-core/src/main/java/org/apache/giraph/io/formats/GiraphTextInputFormat.java +++ b/giraph-core/src/main/java/org/apache/giraph/io/formats/GiraphTextInputFormat.java @@ -30,9 +30,9 @@ import org.apache.hadoop.mapreduce.TaskAttemptContext; import org.apache.hadoop.mapreduce.lib.input.LineRecordReader; /** - * Provides functionality similar to {@link org.apache.hadoop - * .mapreduce.lib.input.TextInputFormat}, but allows for different data - * sources (vertex and edge data). + * Provides functionality similar to + * {@link org.apache.hadoop.mapreduce.lib.input.TextInputFormat}, + * but allows for different data sources (vertex and edge data). */ public class GiraphTextInputFormat extends GiraphFileInputFormat<LongWritable, Text> { http://git-wip-us.apache.org/repos/asf/giraph/blob/458ddd8f/giraph-core/src/main/java/org/apache/giraph/io/formats/LongDoubleDoubleAdjacencyListVertexInputFormat.java ---------------------------------------------------------------------- diff --git a/giraph-core/src/main/java/org/apache/giraph/io/formats/LongDoubleDoubleAdjacencyListVertexInputFormat.java b/giraph-core/src/main/java/org/apache/giraph/io/formats/LongDoubleDoubleAdjacencyListVertexInputFormat.java index 717975d..18e4a52 100644 --- a/giraph-core/src/main/java/org/apache/giraph/io/formats/LongDoubleDoubleAdjacencyListVertexInputFormat.java +++ b/giraph-core/src/main/java/org/apache/giraph/io/formats/LongDoubleDoubleAdjacencyListVertexInputFormat.java @@ -50,7 +50,8 @@ public class LongDoubleDoubleAdjacencyListVertexInputFormat AdjacencyListTextVertexReader { /** - * Constructor with {@link LineSanitizer}. + * Constructor with + * {@link AdjacencyListTextVertexInputFormat.LineSanitizer}. * * @param lineSanitizer the sanitizer to use for reading */ http://git-wip-us.apache.org/repos/asf/giraph/blob/458ddd8f/giraph-core/src/main/java/org/apache/giraph/io/formats/TextDoubleDoubleAdjacencyListVertexInputFormat.java ---------------------------------------------------------------------- diff --git a/giraph-core/src/main/java/org/apache/giraph/io/formats/TextDoubleDoubleAdjacencyListVertexInputFormat.java b/giraph-core/src/main/java/org/apache/giraph/io/formats/TextDoubleDoubleAdjacencyListVertexInputFormat.java index 17174a3..f8a7406 100644 --- a/giraph-core/src/main/java/org/apache/giraph/io/formats/TextDoubleDoubleAdjacencyListVertexInputFormat.java +++ b/giraph-core/src/main/java/org/apache/giraph/io/formats/TextDoubleDoubleAdjacencyListVertexInputFormat.java @@ -47,7 +47,8 @@ public class TextDoubleDoubleAdjacencyListVertexInputFormat AdjacencyListTextVertexReader { /** - * Constructor with {@link LineSanitizer}. + * Constructor with + * {@link AdjacencyListTextVertexInputFormat.LineSanitizer}. * * @param lineSanitizer the sanitizer to use for reading */ http://git-wip-us.apache.org/repos/asf/giraph/blob/458ddd8f/giraph-core/src/main/java/org/apache/giraph/utils/YourKitContext.java ---------------------------------------------------------------------- diff --git a/giraph-core/src/main/java/org/apache/giraph/utils/YourKitContext.java b/giraph-core/src/main/java/org/apache/giraph/utils/YourKitContext.java index 5a05113..8de4537 100644 --- a/giraph-core/src/main/java/org/apache/giraph/utils/YourKitContext.java +++ b/giraph-core/src/main/java/org/apache/giraph/utils/YourKitContext.java @@ -83,7 +83,7 @@ public class YourKitContext { /** * This method is just a convenient replacement of * {@link #captureSnapshot(long, java.io.File)} with - * {@link com.yourkit.api.ProfilingModes.SNAPSHOT_WITH_HEAP} for the flags. + * {@link com.yourkit.api.ProfilingModes#SNAPSHOT_WITH_HEAP} for the flags. * * WARNING: This is likely to be VERY slow for large jobs. * @@ -97,7 +97,7 @@ public class YourKitContext { /** * This method is just a convenient replacement of * {@link #captureSnapshot(long, java.io.File)} with - * {@link com.yourkit.api.ProfilingModes.SNAPSHOT_WITHOUT_HEAP} for the flags. + * {@link com.yourkit.api.ProfilingModes#SNAPSHOT_WITHOUT_HEAP} for the flags. * * @param context map context * @param name unique name for this snapshot http://git-wip-us.apache.org/repos/asf/giraph/blob/458ddd8f/giraph-core/src/main/java/org/apache/giraph/utils/YourKitProfiler.java ---------------------------------------------------------------------- diff --git a/giraph-core/src/main/java/org/apache/giraph/utils/YourKitProfiler.java b/giraph-core/src/main/java/org/apache/giraph/utils/YourKitProfiler.java index 69f9c00..88832b0 100644 --- a/giraph-core/src/main/java/org/apache/giraph/utils/YourKitProfiler.java +++ b/giraph-core/src/main/java/org/apache/giraph/utils/YourKitProfiler.java @@ -51,7 +51,7 @@ public class YourKitProfiler { /** * Convenient replacement of {@link #startProfilingCPU(long)} with - * {@link ProfilingModes.CPU_TRACING} for the mode. + * {@link ProfilingModes#CPU_TRACING} for the mode. * * @param conf GiraphConfiguration * @return profiler context http://git-wip-us.apache.org/repos/asf/giraph/blob/458ddd8f/giraph-examples/src/main/java/org/apache/giraph/examples/VertexWithDoubleValueDoubleEdgeTextOutputFormat.java ---------------------------------------------------------------------- diff --git a/giraph-examples/src/main/java/org/apache/giraph/examples/VertexWithDoubleValueDoubleEdgeTextOutputFormat.java b/giraph-examples/src/main/java/org/apache/giraph/examples/VertexWithDoubleValueDoubleEdgeTextOutputFormat.java index 3d06561..f42941e 100644 --- a/giraph-examples/src/main/java/org/apache/giraph/examples/VertexWithDoubleValueDoubleEdgeTextOutputFormat.java +++ b/giraph-examples/src/main/java/org/apache/giraph/examples/VertexWithDoubleValueDoubleEdgeTextOutputFormat.java @@ -39,7 +39,8 @@ public class VertexWithDoubleValueDoubleEdgeTextOutputFormat extends } /** - * Vertex writer used with {@link VertexWithComponentTextOutputFormat}. + * Vertex writer used with + * {@link VertexWithDoubleValueDoubleEdgeTextOutputFormat}. */ public class VertexWithDoubleValueWriter extends TextVertexWriter { @Override http://git-wip-us.apache.org/repos/asf/giraph/blob/458ddd8f/giraph-hcatalog/src/main/java/org/apache/giraph/io/hcatalog/HCatalogVertexInputFormat.java ---------------------------------------------------------------------- diff --git a/giraph-hcatalog/src/main/java/org/apache/giraph/io/hcatalog/HCatalogVertexInputFormat.java b/giraph-hcatalog/src/main/java/org/apache/giraph/io/hcatalog/HCatalogVertexInputFormat.java index b5dcdfd..53c7eed 100644 --- a/giraph-hcatalog/src/main/java/org/apache/giraph/io/hcatalog/HCatalogVertexInputFormat.java +++ b/giraph-hcatalog/src/main/java/org/apache/giraph/io/hcatalog/HCatalogVertexInputFormat.java @@ -46,9 +46,9 @@ import org.apache.log4j.Logger; * The desired database and table name to load from can be specified via * {@link GiraphHCatInputFormat#setVertexInput(org.apache.hadoop.mapreduce.Job, * org.apache.hcatalog.mapreduce.InputJobInfo)} - * as you setup your vertex input format with - * {@link org.apache.giraph.conf.GiraphConfiguration# - * setVertexInputFormatClass(Class)}. + * as you setup your vertex input format with {@link + * org.apache.giraph.conf.GiraphConfiguration#setVertexInputFormatClass(Class) + * }. * * @param <I> Vertex id * @param <V> Vertex value http://git-wip-us.apache.org/repos/asf/giraph/blob/458ddd8f/giraph-hive/src/main/java/org/apache/giraph/hive/output/HiveRecordSaver.java ---------------------------------------------------------------------- diff --git a/giraph-hive/src/main/java/org/apache/giraph/hive/output/HiveRecordSaver.java b/giraph-hive/src/main/java/org/apache/giraph/hive/output/HiveRecordSaver.java index e8b3f3d..3477211 100644 --- a/giraph-hive/src/main/java/org/apache/giraph/hive/output/HiveRecordSaver.java +++ b/giraph-hive/src/main/java/org/apache/giraph/hive/output/HiveRecordSaver.java @@ -23,7 +23,7 @@ import com.facebook.hiveio.record.HiveWritableRecord; import java.io.IOException; /** - * Interface which can save {@link HiveRecord}s. + * Interface which can save {@link HiveWritableRecord}s. */ public interface HiveRecordSaver { /**
