Commit fb6c2fe8 authored by Kelsi M. Riley's avatar Kelsi M. Riley
Browse files

Update the IGraph Interface documentation.

Fixed the documentation for the addEdge() and addUndirectedEdge()
methods to indicate that the graph should still be updated even if the
edge is already present.
parent 083e806c
1 merge request!1Update the IGraph Interface documentation.
Pipeline #8959 failed with stage
in 0 seconds
Showing with 2 additions and 2 deletions
+2 -2
......@@ -14,7 +14,7 @@ public abstract class IGraph<V, E> {
* @param e The edge to add.
* @throws IllegalArgumentException
* If e is not a valid edge (eg. refers to vertices not in the graph).
* @return true If e was not already present; false if it was (in which case the graph is not updated).
* @return true If e was not already present; false if it was (in which case the graph is still updated).
*/
public abstract boolean addEdge(V src, V dest, E e);
......@@ -24,7 +24,7 @@ public abstract class IGraph<V, E> {
* @param e The edge to add.
* @throws IllegalArgumentException
* If e is not a valid edge (eg. refers to vertices not in the graph).
* @return true If e was not already present in either direction; false if it was (in which case the graph is not updated).
* @return true If e was not already present in either direction; false if it was (in which case the graph is still updated).
*/
public abstract boolean addUndirectedEdge(V src, V dest, E e);
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment