You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@giraph.apache.org by jg...@apache.org on 2012/02/03 21:06:55 UTC
svn commit: r1240327 - in /incubator/giraph/trunk: ./
src/main/java/org/apache/giraph/bsp/ src/main/java/org/apache/giraph/comm/
src/main/java/org/apache/giraph/graph/
src/main/java/org/apache/giraph/graph/partition/
Author: jghoman
Date: Fri Feb 3 20:06:54 2012
New Revision: 1240327
URL: http://svn.apache.org/viewvc?rev=1240327&view=rev
Log:
GIRAPH-130: Fix Javadoc warnings. Contributed by Harsh J. Chouraria.
Modified:
incubator/giraph/trunk/CHANGELOG
incubator/giraph/trunk/src/main/java/org/apache/giraph/bsp/CentralizedServiceWorker.java
incubator/giraph/trunk/src/main/java/org/apache/giraph/comm/CommunicationsInterface.java
incubator/giraph/trunk/src/main/java/org/apache/giraph/comm/VertexIdMessagesList.java
incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/AggregatorWriter.java
incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/GiraphJob.java
incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/VertexCombiner.java
incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/partition/MasterGraphPartitioner.java
incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/partition/PartitionBalancer.java
Modified: incubator/giraph/trunk/CHANGELOG
URL: http://svn.apache.org/viewvc/incubator/giraph/trunk/CHANGELOG?rev=1240327&r1=1240326&r2=1240327&view=diff
==============================================================================
--- incubator/giraph/trunk/CHANGELOG (original)
+++ incubator/giraph/trunk/CHANGELOG Fri Feb 3 20:06:54 2012
@@ -2,6 +2,8 @@ Giraph Change Log
Release 0.2.0 - unreleased
+ GIRAPH-130: Fix Javadoc warnings. (Harsh J. Chouraria via jghoman)
+
GIRAPH-137: De-duplicate pagerank implementation in PageRankBenchmark.
(Harsh J. Chouraria via jghoman)
Modified: incubator/giraph/trunk/src/main/java/org/apache/giraph/bsp/CentralizedServiceWorker.java
URL: http://svn.apache.org/viewvc/incubator/giraph/trunk/src/main/java/org/apache/giraph/bsp/CentralizedServiceWorker.java?rev=1240327&r1=1240326&r2=1240327&view=diff
==============================================================================
--- incubator/giraph/trunk/src/main/java/org/apache/giraph/bsp/CentralizedServiceWorker.java (original)
+++ incubator/giraph/trunk/src/main/java/org/apache/giraph/bsp/CentralizedServiceWorker.java Fri Feb 3 20:06:54 2012
@@ -31,6 +31,7 @@ import org.apache.giraph.graph.GraphMapp
import org.apache.giraph.graph.partition.Partition;
import org.apache.giraph.graph.partition.PartitionOwner;
import org.apache.giraph.graph.partition.PartitionStats;
+import org.apache.giraph.graph.partition.WorkerGraphPartitioner;
import org.apache.giraph.graph.WorkerInfo;
import org.apache.giraph.graph.WorkerContext;
@@ -122,7 +123,6 @@ public interface CentralizedServiceWorke
* Every client will need to get a partition owner from a vertex id so that
* they know which worker to sent the request to.
*
- * @param superstep Superstep to look for
* @param vertexIndex Vertex index to look for
* @return PartitionOnwer that should contain this vertex if it exists
*/
@@ -138,7 +138,7 @@ public interface CentralizedServiceWorke
/**
* If desired by the user, vertex partitions are redistributed among
- * workers according to the chosen {@link GraphPartitioner}.
+ * workers according to the chosen {@link WorkerGraphPartitioner}.
*
* @param masterSetPartitionOwners Partition owner info passed from the
* master.
Modified: incubator/giraph/trunk/src/main/java/org/apache/giraph/comm/CommunicationsInterface.java
URL: http://svn.apache.org/viewvc/incubator/giraph/trunk/src/main/java/org/apache/giraph/comm/CommunicationsInterface.java?rev=1240327&r1=1240326&r2=1240327&view=diff
==============================================================================
--- incubator/giraph/trunk/src/main/java/org/apache/giraph/comm/CommunicationsInterface.java (original)
+++ incubator/giraph/trunk/src/main/java/org/apache/giraph/comm/CommunicationsInterface.java Fri Feb 3 20:06:54 2012
@@ -77,8 +77,7 @@ public interface CommunicationsInterface
/**
* Adds a list of vertex ids and their respective message lists.
*
- * @param vertexIndex Vertex index where the message are added
- * @param msgList messages added
+ * @param vertexIdMessagesList messages to be added
* @throws IOException
*/
void putVertexIdMessagesList(
Modified: incubator/giraph/trunk/src/main/java/org/apache/giraph/comm/VertexIdMessagesList.java
URL: http://svn.apache.org/viewvc/incubator/giraph/trunk/src/main/java/org/apache/giraph/comm/VertexIdMessagesList.java?rev=1240327&r1=1240326&r2=1240327&view=diff
==============================================================================
--- incubator/giraph/trunk/src/main/java/org/apache/giraph/comm/VertexIdMessagesList.java (original)
+++ incubator/giraph/trunk/src/main/java/org/apache/giraph/comm/VertexIdMessagesList.java Fri Feb 3 20:06:54 2012
@@ -23,7 +23,7 @@ import org.apache.hadoop.io.WritableComp
/**
* Wrapper around {@link ArrayListWritable} that provides the list for
- * {@link VertexIdMessage}.
+ * {@link VertexIdMessages}.
*
* @param <I extends Writable> vertex id
* @param <M extends Writable> message data
Modified: incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/AggregatorWriter.java
URL: http://svn.apache.org/viewvc/incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/AggregatorWriter.java?rev=1240327&r1=1240326&r2=1240327&view=diff
==============================================================================
--- incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/AggregatorWriter.java (original)
+++ incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/AggregatorWriter.java Fri Feb 3 20:06:54 2012
@@ -53,7 +53,7 @@ public interface AggregatorWriter {
* whether to write the aggregators values for the current superstep. For
* the last superstep, {@link AggregatorWriter#LAST_SUPERSTEP} is passed.
*
- * @param map Map of aggregators to write
+ * @param aggregatorMap Map of aggregators to write
* @param superstep Current superstep
* @throws IOException
*/
Modified: incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/GiraphJob.java
URL: http://svn.apache.org/viewvc/incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/GiraphJob.java?rev=1240327&r1=1240326&r2=1240327&view=diff
==============================================================================
--- incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/GiraphJob.java (original)
+++ incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/GiraphJob.java Fri Feb 3 20:06:54 2012
@@ -433,7 +433,7 @@ public class GiraphJob extends Job {
/**
* Set the graph partitioner class (optional)
*
- * @param graphPartitionerClass Determines how the graph is partitioned
+ * @param graphPartitionerFactoryClass Determines how the graph is partitioned
*/
final public void setGraphPartitionerFactoryClass(
Class<?> graphPartitionerFactoryClass) {
Modified: incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/VertexCombiner.java
URL: http://svn.apache.org/viewvc/incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/VertexCombiner.java?rev=1240327&r1=1240326&r2=1240327&view=diff
==============================================================================
--- incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/VertexCombiner.java (original)
+++ incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/VertexCombiner.java Fri Feb 3 20:06:54 2012
@@ -40,7 +40,7 @@ public abstract class VertexCombiner<I e
* @param messages Iterable of the messages to be combined
* @return Iterable of the combined messages. The returned value cannot
* be null and its size is required to be smaller or equal to
- * the size of {@link messages}.
+ * the size of the messages list.
* @throws IOException
*/
public abstract Iterable<M> combine(I vertexIndex,
Modified: incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/partition/MasterGraphPartitioner.java
URL: http://svn.apache.org/viewvc/incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/partition/MasterGraphPartitioner.java?rev=1240327&r1=1240326&r2=1240327&view=diff
==============================================================================
--- incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/partition/MasterGraphPartitioner.java (original)
+++ incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/partition/MasterGraphPartitioner.java Fri Feb 3 20:06:54 2012
@@ -50,10 +50,10 @@ public interface MasterGraphPartitioner<
* After the worker stats have been merged to a single list, the master can
* use this information to send commands to the workers for any
* {@link Partition} changes. This protocol is specific to the
- * {@link GraphPartitioner} implementation.
+ * {@link MasterGraphPartitioner} implementation.
*
* @param allPartitionStatsList All partition stats from all workers.
- * @param availableWorkerInfos Workers available for partition assignment
+ * @param availableWorkers Workers available for partition assignment
* @param maxWorkers Maximum number of workers
* @param superstep Partition owners will be set for this superstep
* @return Collection of {@link PartitionOwner} objects that changed from
Modified: incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/partition/PartitionBalancer.java
URL: http://svn.apache.org/viewvc/incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/partition/PartitionBalancer.java?rev=1240327&r1=1240326&r2=1240327&view=diff
==============================================================================
--- incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/partition/PartitionBalancer.java (original)
+++ incubator/giraph/trunk/src/main/java/org/apache/giraph/graph/partition/PartitionBalancer.java Fri Feb 3 20:06:54 2012
@@ -169,7 +169,7 @@ public class PartitionBalancer {
* Balance the partitions with an algorithm based on a value.
*
* @param conf Configuration to find the algorithm
- * @param allPartitionStatsList All the partition stats
+ * @param allPartitionStats All the partition stats
* @param availableWorkerInfos All the available workers
* @return Balanced partition owners
*/