From: Brian Norris <banorris@uci.edu>
Date: Wed, 6 Jun 2012 16:48:54 +0000 (-0700)
Subject: action: fix some comments
X-Git-Tag: pldi2013~391^2~40
X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=e2eb82b1466137e5737056b5cadf00ea86d90353;p=model-checker.git

action: fix some comments
---

diff --git a/action.h b/action.h
index bf5e6c3..976fd48 100644
--- a/action.h
+++ b/action.h
@@ -25,10 +25,10 @@ typedef enum action_type {
 /* Forward declaration */
 class Node;
 class ClockVector;
+
 /**
  * The ModelAction class encapsulates an atomic action.
  */
-
 class ModelAction {
 public:
 	ModelAction(action_type_t type, memory_order order, void *loc, int value);
@@ -79,16 +79,18 @@ private:
 	/** The thread id that performed this action. */
 	thread_id_t tid;
 	
-	/** The value written.  This should probably be something longer. */
+	/** The value read or written (if RMW, then the value written). This
+	 * should probably be something longer. */
 	int value;
 
+	/** A back reference to a Node in NodeStack, if this ModelAction is
+	 * saved on the NodeStack. */
 	Node *node;
 	
 	int seq_number;
 
-	/** The clock vector stored with this action if this action is a
-	 *  store release */
-
+	/** The clock vector stored with this action; only needed if this
+	 * action is a store release? */
 	ClockVector *cv;
 };