commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From simonetrip...@apache.org
Subject svn commit: r1141822 - /commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Path.java
Date Fri, 01 Jul 2011 06:02:44 GMT
Author: simonetripodi
Date: Fri Jul  1 06:02:43 2011
New Revision: 1141822

URL: http://svn.apache.org/viewvc?rev=1141822&view=rev
Log:
fixed Javadoc

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

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=1141822&r1=1141821&r2=1141822&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 Fri Jul 
1 06:02:43 2011
@@ -33,30 +33,41 @@ public interface Path<V extends Vertex, 
 
     /**
      * Returns the source of the path.
+     *
+     * @return the source of the path.
      */
     V getSource();
 
     /**
      * Returns the target of the path.
+     *
+     * @return the target of the path.
      */
     V getTarget();
 
     /**
-     * getVertices() - This returns a list of Vertices, in order as they go from
-     * Start to End. This includes the Start and End vertex, and will have one
+     * Returns a list of Vertices, in order as they go from Start to End.
+     *
+     * This includes the Start and End vertex, and will have one
      * more entry than the Edges list.
+     *
+     * @return a list of Vertices, in order as they go from Start to End.
      */
     List<V> getVertices();
 
     /**
-     * getEdges() - This returns a list of Edges which comprise the path. It
-     * will have one less than the list of Vertices.
+     * Returns a list of Edges which comprise the path.
+     *
+     * It will have one less than the list of Vertices.
+     *
+     * @return a list of Edges which comprise the path.
      */
     List<E> getEdges();
 
     /**
-     * size() - This returns the size of the path in terms of number of
-     * verticies it visits.
+     * Returns the size of the path in terms of number of vertices it visits.
+     *
+     * @return the size of the path in terms of number of vertices it visits.
      */
     int size();
 



Mime
View raw message