You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by si...@apache.org on 2011/06/13 21:39:23 UTC

svn commit: r1135243 - /commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/visit/Visit.java

Author: simonetripodi
Date: Mon Jun 13 19:39:23 2011
New Revision: 1135243

URL: http://svn.apache.org/viewvc?rev=1135243&view=rev
Log:
added missing javadoc

Modified:
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/visit/Visit.java

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/visit/Visit.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/visit/Visit.java?rev=1135243&r1=1135242&r2=1135243&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/visit/Visit.java (original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/visit/Visit.java Mon Jun 13 19:39:23 2011
@@ -35,13 +35,13 @@ public final class Visit
 {
 
     /**
-     * 
+     * Breadth-first search algorithm implementation.
      *
-     * @param <V>
-     * @param <E>
-     * @param graph
-     * @param source
-     * @param handler
+     * @param <V> the Graph vertices type
+     * @param <E> the Graph edges type
+     * @param graph the Graph instance has to be visited
+     * @param source the root node the search begins from
+     * @param handler the handler intercepts visit actions
      */
     public final <V extends Vertex, E extends Edge<V>> void breadthFirstSearch( Graph<V, E> graph, V source,
                                                                                 GraphVisitHandler<V, E> handler )
@@ -81,13 +81,13 @@ public final class Visit
     }
 
     /**
-     * 
+     * Depth-first search algorithm implementation.
      *
-     * @param <V>
-     * @param <E>
-     * @param graph
-     * @param source
-     * @param handler
+     * @param <V> the Graph vertices type
+     * @param <E> the Graph edges type
+     * @param graph the Graph instance has to be visited
+     * @param source the root node the search begins from
+     * @param handler the handler intercepts visit actions
      */
     public final <V extends Vertex, E extends Edge<V>> void depthFirstSearch( Graph<V, E> graph, V source,
                                                                               GraphVisitHandler<V, E> handler )