commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From marcospera...@apache.org
Subject svn commit: r1328969 - in /commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph: ./ coloring/ shortestpath/ spanning/ visit/
Date Sun, 22 Apr 2012 20:30:27 GMT
Author: marcosperanza
Date: Sun Apr 22 20:30:27 2012
New Revision: 1328969

URL: http://svn.apache.org/viewvc?rev=1328969&view=rev
Log:
Removed unsatisfied javadoc links to class Edge and Vertex

Modified:
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/DirectedGraph.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Graph.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/MutableGraph.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Path.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/VertexPair.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/WeightedPath.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/coloring/ColoredVertices.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/shortestpath/PredecessorsList.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/spanning/DefaultSpanningTreeAlgorithmSelector.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/spanning/ShortestEdges.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/spanning/SuperVertex.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/visit/DefaultVisitAlgorithmsSelector.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/visit/GraphVisitHandler.java

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/DirectedGraph.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/DirectedGraph.java?rev=1328969&r1=1328968&r2=1328969&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/DirectedGraph.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/DirectedGraph.java
Sun Apr 22 20:30:27 2012
@@ -34,34 +34,34 @@ public interface DirectedGraph<V, E>
 {
 
     /**
-     * For a {@link Vertex}, the number of head endpoints adjacent to a node is called the
indegree.
+     * For a vertex, the number of head endpoints adjacent to a node is called the indegree.
      *
-     * @param v the {@link Vertex} which indegree has to be returned.
-     * @return the number of head endpoints adjacent to a {@link Vertex}.
+     * @param v the vertex which indegree has to be returned.
+     * @return the number of head endpoints adjacent to a vertex.
      */
     int getInDegree( V v );
 
     /**
-     * Returns the set of {@link Edge}s which are inbound to the {@link Vertex}.
+     * Returns the set of edges which are inbound to the vertex.
      *
-     * @param v the {@link Vertex} which inbound {@link Vertex}s have to be returned
-     * @return the set of {@link Vertex}s which are inbound to the {@link Vertex}.
+     * @param v the vertex which inbound vertexs have to be returned
+     * @return the set of vertexs which are inbound to the vertex.
      */
     Iterable<V> getInbound( V v );
 
     /**
-     * For a {@link Vertex}, the number of tail endpoints adjacent to a node is called the
outdegree.
+     * For a vertex, the number of tail endpoints adjacent to a node is called the outdegree.
      *
-     * @param v the {@link Vertex} which indegree has to be returned.
-     * @return the number of head endpoints adjacent to a {@link Vertex}.
+     * @param v the vertex which indegree has to be returned.
+     * @return the number of head endpoints adjacent to a vertex.
      */
     int getOutDegree( V v );
 
     /**
-     * Returns the set of {@link Vertex}s which lead away from the {@link Vertex}.
+     * Returns the set of vertexs which lead away from the vertex.
      *
-     * @param v the {@link Vertex} which outbound {@link Vertex}s have to be returned
-     * @return the set of {@link Vertex}s which lead away from the {@link Vertex}.
+     * @param v the vertex which outbound vertexs have to be returned
+     * @return the set of vertexs which lead away from the vertex.
      */
     Iterable<V> getOutbound( V v );
 

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Graph.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Graph.java?rev=1328969&r1=1328968&r2=1328969&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Graph.java (original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Graph.java Sun Apr
22 20:30:27 2012
@@ -22,8 +22,8 @@ package org.apache.commons.graph;
 import java.io.Serializable;
 
 /**
- * A Graph data structure consists of a finite (and possibly mutable) set of ordered pairs,
called {@link Edge}s or
- * arcs, of certain entities called {@link Vertex} or node. As in mathematics, an {@link
Edge} {@code (x,y)} is said to
+ * A Graph data structure consists of a finite (and possibly mutable) set of ordered pairs,
called edges or
+ * arcs, of certain entities called vertex or node. As in mathematics, an edge {@code (x,y)}
is said to
  * point or go from {@code x} to {@code y}.
  *
  * @param <V> the Graph vertices type
@@ -74,14 +74,14 @@ public interface Graph<V, E>
     int getSize();
 
     /**
-     * The degree (or valency) of a {@link Vertex} of a {@link Graph}
-     * is the number of {@link Edge}s incident to the {@link Vertex}.
+     * The degree (or valency) of a vertex of a {@link Graph}
+     * is the number of edges incident to the vertex.
      *
      * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
      * if an error occurs while performing that operation.
      *
-     * @param v the {@link Vertex} which degree has to be returned.
-     * @return the number of {@link Edge}s incident to the {@link Vertex}.
+     * @param v the vertex which degree has to be returned.
+     * @return the number of edges incident to the vertex.
      */
     int getDegree( V v );
 
@@ -91,7 +91,7 @@ public interface Graph<V, E>
      * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
      * if an error occurs while performing that operation.
      *
-     * @param v the {@link Vertex} which connected vertices have to be returned.
+     * @param v the vertex which connected vertices have to be returned.
      * @return all vertices which touch this vertex.
      */
     Iterable<V> getConnectedVertices( V v );
@@ -109,13 +109,13 @@ public interface Graph<V, E>
     E getEdge( V source, V target );
 
     /**
-     * Return the set of {@link Vertex} on the input {@link Edge} (2 for normal edges, >
2 for HyperEdges)
+     * Return the set of vertex on the input edge (2 for normal edges, > 2 for HyperEdges)
      *
      * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
      * if an error occurs while performing that operation.
      *
-     * @param e the input {@link Edge}
-     * @return the set of {@link Vertex} on this Edge.
+     * @param e the input edge
+     * @return the set of vertex on this Edge.
      */
     VertexPair<V> getVertices( E e );
 
@@ -125,7 +125,7 @@ public interface Graph<V, E>
      * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
      * if an error occurs while performing that operation.
      *
-     * @param v the {@link Vertex} to be checked
+     * @param v the vertex to be checked
      * @return Returns true if the vertex is contained into the graph, false otherwise
      */
     boolean containsVertex( V v );
@@ -136,7 +136,7 @@ public interface Graph<V, E>
      * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
      * if an error occurs while performing that operation.
      *
-     * @param e the {@link Edge} to be checked
+     * @param e the edge to be checked
      * @return Returns true if the edge is contained into the graph, false otherwise
      */
     boolean containsEdge( E e );

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/MutableGraph.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/MutableGraph.java?rev=1328969&r1=1328968&r2=1328969&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/MutableGraph.java (original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/MutableGraph.java Sun
Apr 22 20:30:27 2012
@@ -20,7 +20,7 @@ package org.apache.commons.graph;
  */
 
 /**
- * The {@code MutableGraph} is a graph that supports the addition and removal of {@link Vertex}
and {@link Edge}s.
+ * The {@code MutableGraph} is a graph that supports the addition and removal of vertex and
edges.
  *
  * @param <V> the Graph vertices type
  * @param <E> the Graph edges type
@@ -30,44 +30,44 @@ public interface MutableGraph<V, E>
 {
 
     /**
-     * Adds a feature to the {@link Vertex} attribute of the {@code MutableGraph} object.
+     * Adds a feature to the vertex attribute of the {@code MutableGraph} object.
      *
      * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
      * if an error occurs while performing that operation.
      *
-     * @param v the {@link Vertex} has to be added in this {@code MutableGraph} instance.
+     * @param v the vertex has to be added in this {@code MutableGraph} instance.
      */
     void addVertex( V v );
 
     /**
-     * Removes the {@link Vertex} from the {@code MutableGraph} object.
+     * Removes the vertex from the {@code MutableGraph} object.
      *
      * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
      * if an error occurs while performing that operation.
      *
-     * @param v the {@link Vertex} has to be removed from this {@code MutableGraph} instance.
+     * @param v the vertex has to be removed from this {@code MutableGraph} instance.
      */
     void removeVertex( V v );
 
     /**
-     * Adds a feature to the {@link Edge} attribute of the {@code MutableGraph} object
+     * Adds a feature to the edge attribute of the {@code MutableGraph} object
      *
      * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
      * if an error occurs while performing that operation.
      *
-     * @param head the head {@link Vertex}
-     * @param e the {@link Edge} has to be added in this {@code MutableGraph} instance.
-     * @param tail the tail {@link Vertex}
+     * @param head the head vertex
+     * @param e the edge has to be added in this {@code MutableGraph} instance.
+     * @param tail the tail vertex
      */
     void addEdge( V head, E e, V tail );
 
     /**
-     * Removed the {@link Edge} from the {@code MutableGraph} object.
+     * Removed the edge from the {@code MutableGraph} object.
      *
      * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
      * if an error occurs while performing that operation.
      *
-     * @param e the {@link Edge} has to be removed from this {@code MutableGraph} instance.
+     * @param e the edge has to be removed from this {@code MutableGraph} instance.
      */
     void removeEdge( E e );
 

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Path.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Path.java?rev=1328969&r1=1328968&r2=1328969&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Path.java (original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Path.java Sun Apr 22
20:30:27 2012
@@ -20,8 +20,8 @@ package org.apache.commons.graph;
  */
 
 /**
- * A {@code Path} in a {@link Graph} is a sequence of {@link Vertex} such that from each
of its vertices there is an
- * {@link Edge} to the next {@link Vertex} in the sequence.
+ * A {@code Path} in a {@link Graph} is a sequence of vertex such that from each of its vertices
there is an
+ * edge to the next vertex in the sequence.
  *
  * @param <V> the Graph vertices type
  * @param <E> the Graph edges type

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/VertexPair.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/VertexPair.java?rev=1328969&r1=1328968&r2=1328969&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/VertexPair.java (original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/VertexPair.java Sun
Apr 22 20:30:27 2012
@@ -27,7 +27,7 @@ import static org.apache.commons.graph.u
 import java.io.Serializable;
 
 /**
- * Indicates a {@link Vertex} pair.
+ * Indicates a vertex pair.
  *
  * @param <V> the Graph vertices type
  */
@@ -43,7 +43,7 @@ public final class VertexPair<V>
     private final V tail;
 
     /**
-     * Initializes a new {@link Vertex} pair.
+     * Initializes a new vertex pair.
      *
      * @param head the head Vertex
      * @param tail the tail Vertex

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/WeightedPath.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/WeightedPath.java?rev=1328969&r1=1328968&r2=1328969&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/WeightedPath.java (original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/WeightedPath.java Sun
Apr 22 20:30:27 2012
@@ -20,7 +20,7 @@ package org.apache.commons.graph;
  */
 
 /**
- * A {@code Path} whose {@link Edge}s are {@link Weighted}.
+ * A {@code Path} whose edges are {@link Weighted}.
  *
  * @param <V> the Graph vertices type
  * @param <E> the Graph weighted edges type

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/coloring/ColoredVertices.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/coloring/ColoredVertices.java?rev=1328969&r1=1328968&r2=1328969&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/coloring/ColoredVertices.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/coloring/ColoredVertices.java
Sun Apr 22 20:30:27 2012
@@ -29,7 +29,7 @@ import java.util.Map;
 import org.apache.commons.graph.Graph;
 
 /**
- * Maintains the color for each {@link Vertex} and the required number of colors for {@link
Graph} coloring.
+ * Maintains the color for each vertex and the required number of colors for {@link Graph}
coloring.
  *
  * @param <V> the Graph vertices type.
  * @param <C> the Color type.
@@ -50,10 +50,10 @@ public final class ColoredVertices<V, C>
     }
 
     /**
-     * Store the input {@link Vertex} color.
+     * Store the input vertex color.
      *
-     * @param v the {@link Vertex} for which storing the color.
-     * @param color the input {@link Vertex} color.
+     * @param v the vertex for which storing the color.
+     * @param color the input vertex color.
      */
     void addColor( V v, C color )
     {
@@ -70,9 +70,9 @@ public final class ColoredVertices<V, C>
     }
 
     /**
-     * Remove the input {@link Vertex} color.
+     * Remove the input vertex color.
      *
-     * @param v the {@link Vertex} for which storing the color.
+     * @param v the vertex for which storing the color.
      */
     void removeColor( V v )
     {
@@ -81,10 +81,10 @@ public final class ColoredVertices<V, C>
     }
 
     /**
-     * Returns the color associated to the input {@link Vertex}.
+     * Returns the color associated to the input vertex.
      *
-     * @param v the {@link Vertex} for which getting the color.
-     * @return the color associated to the input {@link Vertex}.
+     * @param v the vertex for which getting the color.
+     * @return the color associated to the input vertex.
      */
     public C getColor( V v )
     {

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/shortestpath/PredecessorsList.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/shortestpath/PredecessorsList.java?rev=1328969&r1=1328968&r2=1328969&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/shortestpath/PredecessorsList.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/shortestpath/PredecessorsList.java
Sun Apr 22 20:30:27 2012
@@ -29,8 +29,8 @@ import org.apache.commons.graph.model.In
 import org.apache.commons.graph.weight.Monoid;
 
 /**
- * The predecessor list is a list of {@link Vertex} of a {@link org.apache.commons.graph.Graph}.
- * Each {@link Vertex}' entry contains the index of its predecessor in a path through the
graph.
+ * The predecessor list is a list of vertex of a {@link org.apache.commons.graph.Graph}.
+ * Each vertex' entry contains the index of its predecessor in a path through the graph.
  *
  * @param <V> the Graph vertices type
  * @param <WE> the Graph weighted edges type
@@ -55,7 +55,7 @@ public final class PredecessorsList<V, W
     }
 
     /**
-     * Add an {@link Edge} in the predecessor list associated to the input {@link Vertex}.
+     * Add an edge in the predecessor list associated to the input vertex.
      *
      * @param tail the predecessor vertex
      * @param head the edge that succeeds to the input vertex

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/spanning/DefaultSpanningTreeAlgorithmSelector.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/spanning/DefaultSpanningTreeAlgorithmSelector.java?rev=1328969&r1=1328968&r2=1328969&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/spanning/DefaultSpanningTreeAlgorithmSelector.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/spanning/DefaultSpanningTreeAlgorithmSelector.java
Sun Apr 22 20:30:27 2012
@@ -54,15 +54,15 @@ final class DefaultSpanningTreeAlgorithm
 
     private final Mapper<WE, W> weightedEdges;
 
-    /** The start {@link Vertex}. */
+    /** The start vertex. */
     private final V source;
 
     /**
      * Creates a default {@link SpanningTreeAlgorithmSelector} for the given {@link Graph}
and
-     * start {@link Vertex}.
+     * start vertex.
      *
      * @param graph the {@link Graph} to be used.
-     * @param source the start {@link Vertex}.
+     * @param source the start vertex.
      */
     public DefaultSpanningTreeAlgorithmSelector( final Graph<V, WE> graph, Mapper<WE,
W> weightedEdges, final V source )
     {

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/spanning/ShortestEdges.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/spanning/ShortestEdges.java?rev=1328969&r1=1328968&r2=1328969&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/spanning/ShortestEdges.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/spanning/ShortestEdges.java
Sun Apr 22 20:30:27 2012
@@ -32,8 +32,8 @@ import org.apache.commons.graph.model.Mu
 import org.apache.commons.graph.weight.OrderedMonoid;
 
 /**
- * The predecessor list is a list of {@link Vertex} of a {@link org.apache.commons.graph.Graph}.
- * Each {@link Vertex}' entry contains the index of its predecessor in a path through the
graph.
+ * The predecessor list is a list of vertex of a {@link org.apache.commons.graph.Graph}.
+ * Each vertex' entry contains the index of its predecessor in a path through the graph.
  *
  * @param <V> the Graph vertices type
  * @param <E> the Graph edges type
@@ -62,7 +62,7 @@ final class ShortestEdges<V, WE, W>
     }
 
     /**
-     * Add an {@link Edge} in the predecessor list associated to the input {@link Vertex}.
+     * Add an edge in the predecessor list associated to the input vertex.
      *
      * @param tail the predecessor vertex
      * @param head the edge that succeeds to the input vertex

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/spanning/SuperVertex.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/spanning/SuperVertex.java?rev=1328969&r1=1328968&r2=1328969&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/spanning/SuperVertex.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/spanning/SuperVertex.java
Sun Apr 22 20:30:27 2012
@@ -28,7 +28,7 @@ import org.apache.commons.graph.Graph;
 import org.apache.commons.graph.VertexPair;
 
 /**
- * A {@link SuperVertex} is a collection of {@link Vertex} objects and is only
+ * A {@link SuperVertex} is a collection of vertex objects and is only
  * used internally by Boruvka's algorithm to find a minimum spanning tree.
  *
  * @param <V>  the Graph vertices type

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/visit/DefaultVisitAlgorithmsSelector.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/visit/DefaultVisitAlgorithmsSelector.java?rev=1328969&r1=1328968&r2=1328969&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/visit/DefaultVisitAlgorithmsSelector.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/visit/DefaultVisitAlgorithmsSelector.java
Sun Apr 22 20:30:27 2012
@@ -50,10 +50,10 @@ final class DefaultVisitAlgorithmsSelect
     private final V source;
 
     /**
-     * Create a default {@link VisitAlgorithmsSelector} for the given {@link Graph} and start
{@link Vertex}.
+     * Create a default {@link VisitAlgorithmsSelector} for the given {@link Graph} and start
vertex.
      *
      * @param graph the {@link Graph} to be used.
-     * @param source the start {@link Vertex}.
+     * @param source the start vertex.
      */
     public DefaultVisitAlgorithmsSelector( final G graph, final V source )
     {

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/visit/GraphVisitHandler.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/visit/GraphVisitHandler.java?rev=1328969&r1=1328968&r2=1328969&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/visit/GraphVisitHandler.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/visit/GraphVisitHandler.java
Sun Apr 22 20:30:27 2012
@@ -34,11 +34,11 @@ public interface GraphVisitHandler<V, E,
     void discoverGraph( G graph );
 
     /**
-     * Performs operations on the input {@link Vertex} and determines the behavior of the
visit algorithm
+     * Performs operations on the input vertex and determines the behavior of the visit algorithm
      * based on the return value:
      * <ul>
      *   <li>{@link VisitState.CONTINUE} continues the visit normally;</li> 
-     *   <li>{@link VisitState.SKIP} continues the visit skipping the input {@link
Vertex};</li>
+     *   <li>{@link VisitState.SKIP} continues the visit skipping the input vertex;</li>
      *   <li>{@link VisitState.ABORT} terminates the visit.</li>
      * </ul>
      * @return the state of the visit after operations on the vertex
@@ -46,11 +46,11 @@ public interface GraphVisitHandler<V, E,
     VisitState discoverVertex( V vertex );
 
     /**
-     * Performs operations on the input {@link Edge} and determines the behavior of the visit
algorithm
+     * Performs operations on the input edge and determines the behavior of the visit algorithm
      * based on the return value:
      * <ul>
      *   <li>{@link VisitState.CONTINUE} continues the visit normally;</li> 
-     *   <li>{@link VisitState.SKIP} continues the visit skipping the input {@link
Edge};</li>
+     *   <li>{@link VisitState.SKIP} continues the visit skipping the input edge;</li>
      *   <li>{@link VisitState.ABORT} terminates the visit.</li>
      * </ul>
      * @return the state of the visit after operations on the edge
@@ -59,15 +59,15 @@ public interface GraphVisitHandler<V, E,
 
     /**
      * Checks if the search algorithm should be terminated. Called after the search algorithm
has finished
-     * visiting the input {@link Edge}.
-     * @return {@link VisitState.ABORT} if the search algorithm should be terminated after
visiting the input {@link Edge}, {@link VisitState.CONTINUE} otherwise
+     * visiting the input edge.
+     * @return {@link VisitState.ABORT} if the search algorithm should be terminated after
visiting the input edge, {@link VisitState.CONTINUE} otherwise
      */
     VisitState finishEdge( V head, E edge, V tail );
 
     /**
      * Checks if the search algorithm should be terminated. Called after the search algorithm
has finished
-     * visiting the input {@link Vertex}.
-     * @return {@link VisitState.ABORT} if the search algorithm should be terminated after
visiting the input {@link Vertex}, {@link VisitState.CONTINUE} otherwise
+     * visiting the input vertex.
+     * @return {@link VisitState.ABORT} if the search algorithm should be terminated after
visiting the input vertex, {@link VisitState.CONTINUE} otherwise
      */
     VisitState finishVertex( V vertex );
 



Mime
View raw message