You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2018/05/21 14:00:43 UTC
[11/14] tinkerpop git commit: Fixed some bad javadoc CTR
Fixed some bad javadoc CTR
Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/ae562c18
Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/ae562c18
Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/ae562c18
Branch: refs/heads/TINKERPOP-1963
Commit: ae562c183eee1d708759413e8c31b5db5db07295
Parents: 699a5aa
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Thu May 17 15:42:06 2018 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Thu May 17 15:42:06 2018 -0400
----------------------------------------------------------------------
.../computer/traversal/TraversalVertexProgram.java | 17 +++++++++--------
.../traversal/dsl/graph/GraphTraversal.java | 6 +++---
2 files changed, 12 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/ae562c18/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/computer/traversal/TraversalVertexProgram.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/computer/traversal/TraversalVertexProgram.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/computer/traversal/TraversalVertexProgram.java
index 3cb4d00..8694974 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/computer/traversal/TraversalVertexProgram.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/computer/traversal/TraversalVertexProgram.java
@@ -63,6 +63,7 @@ import org.apache.tinkerpop.gremlin.process.traversal.util.TraversalHelper;
import org.apache.tinkerpop.gremlin.process.traversal.util.TraversalMatrix;
import org.apache.tinkerpop.gremlin.process.traversal.util.TraversalMetrics;
import org.apache.tinkerpop.gremlin.structure.Direction;
+import org.apache.tinkerpop.gremlin.structure.Edge;
import org.apache.tinkerpop.gremlin.structure.Element;
import org.apache.tinkerpop.gremlin.structure.Graph;
import org.apache.tinkerpop.gremlin.structure.Vertex;
@@ -82,15 +83,15 @@ import java.util.List;
import java.util.Optional;
import java.util.Set;
-
/**
- * TraversalVertexProgram enables the evaluation of a {@link Traversal} on a {@link org.apache.tinkerpop.gremlin.process.computer.GraphComputer}.
- * At the start of the computation, each {@link Vertex} (or {@link org.apache.tinkerpop.gremlin.structure.Edge}) is assigned a single {@link Traverser}.
- * For each traverser that is local to the vertex, the vertex looks up its current location in the traversal and processes that step.
- * If the outputted traverser of the step references a local structure on the vertex (e.g. the vertex, an incident edge, its properties, or an arbitrary object),
- * then the vertex continues to compute the next traverser. If the traverser references another location in the graph,
- * then the traverser is sent to that location in the graph via a message. The messages of TraversalVertexProgram are traversers.
- * This continues until all traversers in the computation have halted.
+ * {@code TraversalVertexProgram} enables the evaluation of a {@link Traversal} on a {@link GraphComputer}.
+ * At the start of the computation, each {@link Vertex} (or {@link Edge}) is assigned a single {@link Traverser}.
+ * For each traverser that is local to the vertex, the vertex looks up its current location in the traversal and
+ * processes that step. If the outputted traverser of the step references a local structure on the vertex (e.g. the
+ * vertex, an incident edge, its properties, or an arbitrary object), then the vertex continues to compute the next
+ * traverser. If the traverser references another location in the graph, then the traverser is sent to that location
+ * in the graph via a message. The messages of TraversalVertexProgram are traversers. This continues until all
+ * traversers in the computation have halted.
*
* @author Marko A. Rodriguez (http://markorodriguez.com)
*/
http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/ae562c18/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java
index 222fdab..1dccead 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java
@@ -2406,10 +2406,10 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> {
}
/**
- * Executes a Peer Pressure community detection algorithm over the graph.
+ * Executes an arbitrary {@link VertexProgram} over the graph.
*
- * @return the traversal with the appended {@link PeerPressureVertexProgramStep}
- * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#peerpressure-step" target="_blank">Reference Documentation - PeerPressure Step</a>
+ * @return the traversal with the appended {@link ProgramVertexProgramStep}
+ * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#program-step" target="_blank">Reference Documentation - Program Step</a>
* @since 3.2.0-incubating
*/
public default GraphTraversal<S, E> program(final VertexProgram<?> vertexProgram) {