From fb6c2fe82711d162c76b3b05896c5b15dcda7642 Mon Sep 17 00:00:00 2001
From: Kelsi Riley <kriley@caltech.edu>
Date: Sat, 23 Feb 2019 14:38:07 -0800
Subject: [PATCH] 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.
---
src/edu/caltech/cs2/interfaces/IGraph.java | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/edu/caltech/cs2/interfaces/IGraph.java b/src/edu/caltech/cs2/interfaces/IGraph.java
index e12ac62..6e0e757 100644
--- a/src/edu/caltech/cs2/interfaces/IGraph.java
+++ b/src/edu/caltech/cs2/interfaces/IGraph.java
@@ -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);
--
GitLab