From: Brian Norris <banorris@uci.edu>
Date: Fri, 25 Jan 2013 01:29:58 +0000 (-0800)
Subject: cyclegraph: reformat, improve 'addRMWEdge' comments
X-Git-Tag: oopsla2013~319
X-Git-Url: http://demsky.eecs.uci.edu/git/?p=model-checker.git;a=commitdiff_plain;h=b1de3c01aaea4141cd01410ef739a00f2987b567

cyclegraph: reformat, improve 'addRMWEdge' comments

Make it slightly clearer what this function's intent is. (It's only used
for the introduction of the first edge between 'from' and 'rmw' s.t.:

  from->is_write() && rmw->is_rmw() && from --rf-> rmw
---

diff --git a/cyclegraph.cc b/cyclegraph.cc
index 62cef7c..3214363 100644
--- a/cyclegraph.cc
+++ b/cyclegraph.cc
@@ -92,10 +92,17 @@ void CycleGraph::addEdge(CycleNode *fromnode, CycleNode *tonode)
 	}
 }
 
-/** Handles special case of a RMW action.  The ModelAction rmw reads
- *  from the ModelAction from.  The key differences are: (1) no write
- *  can occur in between the rmw and the from action.  Only one RMW
- *  action can read from a given write.
+/**
+ * @brief Add an edge between a write and the RMW which reads from it
+ *
+ * Handles special case of a RMW action, where the ModelAction rmw reads from
+ * the ModelAction from. The key differences are:
+ * (1) no write can occur in between the rmw and the from action.
+ * (2) Only one RMW action can read from a given write.
+ *
+ * @param from The edge comes from this ModelAction
+ * @param rmw The edge points to this ModelAction; this action must read from
+ * ModelAction from
  */
 void CycleGraph::addRMWEdge(const ModelAction *from, const ModelAction *rmw)
 {