svn commit: r1134639 - /commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Graph.java

[si...@apache.org]

Author: simonetripodi
Date: Sat Jun 11 14:01:04 2011
New Revision: 1134639

URL: http://svn.apache.org/viewvc?rev=1134639&view=rev
Log:
fixed javadoc violations

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

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=1134639&r1=1134638&r2=1134639&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 Sat Jun 11 14:01:04 2011
@@ -27,24 +27,30 @@ public interface Graph<V extends Vertex,
 {
 
     /**
-     * getVertices - Returns the total set of Vertices in the graph.
+     * Returns the total set of Vertices in the graph.
+     *
+     * @return the total set of Vertices in the graph.
      */
     Set<V> getVertices();
 
     /**
-     * getEdges - Returns the total set of Edges in the graph.
+     * Returns the total set of Edges in the graph.
+     *
+     * @return the total set of Edges in the graph.
      */
     Set<V> getEdges();
 
     /**
-     * getEdges( Vertex ) - This method will return all edges which touch this
-     * vertex.
+     * Returns all edges which touch this vertex.
+     *
+     * @return all edges which touch this vertex.
      */
     Set<E> getEdges(Vertex v);
 
     /**
-     * getVertices( Edge ) - This method will return the set of Verticies on
-     * this Edge. (2 for normal edges, > 2 for HyperEdges.)
+     * Return the set of {@link Vertex} on the input {@link Edge} (2 for normal edges, > 2 for HyperEdges)
+     *
+     * @return the set of {@link Vertex} on this Edge.
      */
     Set<E> getVertices(Edge e);