From 4a48748f1c23b3948f81ee2bdc0887365e57f03a Mon Sep 17 00:00:00 2001
From: sjfink <sjfink@f5eafffb-2e1d-0410-98e4-8ec43c5233c4>
Date: Tue, 21 Apr 2009 20:00:40 +0000
Subject: [PATCH] comments

git-svn-id: https://wala.svn.sourceforge.net/svnroot/wala/trunk@3500 f5eafffb-2e1d-0410-98e4-8ec43c5233c4
---
 com.ibm.wala.core/src/com/ibm/wala/util/graph/Graph.java  | 2 ++
 .../src/com/ibm/wala/util/graph/NodeManager.java          | 8 +++++++-
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/com.ibm.wala.core/src/com/ibm/wala/util/graph/Graph.java b/com.ibm.wala.core/src/com/ibm/wala/util/graph/Graph.java
index 5cc928b08..282c5718b 100644
--- a/com.ibm.wala.core/src/com/ibm/wala/util/graph/Graph.java
+++ b/com.ibm.wala.core/src/com/ibm/wala/util/graph/Graph.java
@@ -16,6 +16,8 @@ package com.ibm.wala.util.graph;
  * We choose to define a {@link Graph} as a composition of a {@link NodeManager} and an {@link EdgeManager}, which
  * track nodes and edges, respectively.   This way, in many cases we can compose separate {@link NodeManager} and
  * {@link EdgeManager} implementations to create {@link Graph} implementations, using delegation.
+ * 
+ * @param <T> the type of nodes in this graph.
  */
 public interface Graph<T> extends NodeManager<T>, EdgeManager<T> {
   /**
diff --git a/com.ibm.wala.core/src/com/ibm/wala/util/graph/NodeManager.java b/com.ibm.wala.core/src/com/ibm/wala/util/graph/NodeManager.java
index 828032236..e7d7f2451 100644
--- a/com.ibm.wala.core/src/com/ibm/wala/util/graph/NodeManager.java
+++ b/com.ibm.wala.core/src/com/ibm/wala/util/graph/NodeManager.java
@@ -10,12 +10,18 @@
  *******************************************************************************/
 package com.ibm.wala.util.graph;
 
+import java.util.Collection;
 import java.util.Iterator;
 
 /**
  * An object which tracks graph nodes.
+ * 
+ * This is effectively a stripped-down collection interface. We choose to avoid using the full {@link Collection} interface, so that
+ * it takes less code to implement a new {@link NodeManager}.
+ * 
+ * @param <T> the type of nodes this {@link NodeManager} tracks.
  */
-public interface NodeManager<T> extends Iterable<T>{
+public interface NodeManager<T> extends Iterable<T> {
 
   /**
    * @return an {@link Iterator} of the nodes in this graph