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/11 19:09:07 UTC
svn commit: r1134698 -
/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/MutableGraph.java
Author: simonetripodi
Date: Sat Jun 11 17:09:07 2011
New Revision: 1134698
URL: http://svn.apache.org/viewvc?rev=1134698&view=rev
Log:
fixed javadocs description
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/MutableGraph.java
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=1134698&r1=1134697&r2=1134698&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 Sat Jun 11 17:09:07 2011
@@ -29,37 +29,51 @@ public interface MutableGraph<V extends
{
/**
- * Adds a feature to the Vertex attribute of the MutableGraph object
+ * Adds a feature to the {@link Vertex} attribute of the {@code MutableGraph} object.
+ *
+ * @param v the {@link Vertex} has to be added in this {@code MutableGraph} instance.
*/
void addVertex( V v )
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 MutableGraph} instance.
*/
void removeVertex( V v )
throws GraphException;
/**
- * Adds a feature to the Edge attribute of the MutableGraph object
+ * Adds a feature to the {@link Edge} attribute of the {@code MutableGraph} object
+ *
+ * @param e the {@link Edge} has to be added in this {@code MutableGraph} instance.
*/
void addEdge( E e )
throws GraphException;
/**
- * Description of the Method
+ * Removed the {@link Edge} from the {@code MutableGraph} object.
+ *
+ * @param e the {@link Edge} has to be removed from this {@code MutableGraph} instance.
*/
void removeEdge( E e )
throws GraphException;
/**
- * Description of the Method
+ * Creates a connection between the input {@link Edge} and {@link Vertex}.
+ *
+ * @param e the {@link Edge} has to be connected
+ * @param v the {@link Vertex} has to be connected
*/
void connect( E e, V v )
throws GraphException;
/**
- * Description of the Method
+ * Breaks a connection between the input {@link Edge} and {@link Vertex}.
+ *
+ * @param e the {@link Edge} has to be disconnected
+ * @param v the {@link Vertex} has to be disconnected
*/
void disconnect( E e, V v )
throws GraphException;