svn commit: r1134703 - /commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/MutableDirectedGraph.java

[si...@apache.org]

Author: simonetripodi
Date: Sat Jun 11 17:42:15 2011
New Revision: 1134703

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

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

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/MutableDirectedGraph.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/MutableDirectedGraph.java?rev=1134703&r1=1134702&r2=1134703&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/MutableDirectedGraph.java (original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/MutableDirectedGraph.java Sat Jun 11 17:42:15 2011
@@ -29,25 +29,35 @@ public interface MutableDirectedGraph<V 
 {
 
     /**
-     * Adds a feature to the Vertex attribute of the MutableDirectedGraph object
+     * Adds a feature to the {@link Vertex} attribute of the {@code MutableDirectedGraph} object.
+     *
+     * @param v the {@link Vertex} has to be added in this {@code MutableDirectedGraph} instance.
      */
     public void addVertex( V v )
         throws GraphException;
 
     /**
-     * Adds a feature to the Edge attribute of the MutableDirectedGraph object
+     * Adds a feature to the {@link Edge} attribute of the {@code MutableDirectedGraph} object.
+     *
+     * @param e the {@link Edge} has to be added to this {@code MutableDirectedGraph} object.
+     * @param source the input {@link Edge} source
+     * @param target the input {@link Edge} target
      */
     public void addEdge( E e, V source, V target )
         throws GraphException;
 
     /**
-     * Description of the Method
+     * Removes the {@link Vertex} from the {@code MutableGraph} object.
+     *
+     * @param v the {@link Vertex} has to be removed from this {@code MutableDirectedGraph} instance.
      */
     public void removeVertex( V v )
         throws GraphException;
 
     /**
-     * Description of the Method
+     * Adds a feature to the {@link Edge} attribute of the {@code MutableDirectedGraph} object
+     *
+     * @param e the {@link Edge} has to be added in this {@code MutableDirectedGraph} instance.
      */
     public void removeEdge( E e )
         throws GraphException;