From: Brian Norris <banorris@uci.edu>
Date: Tue, 5 Feb 2013 06:50:45 +0000 (-0800)
Subject: cyclegraph: add documentation
X-Git-Tag: oopsla2013~292
X-Git-Url: http://plrg.eecs.uci.edu/git/?p=model-checker.git;a=commitdiff_plain;h=4da2859902f1096053a2d9857df502d3bb94e6e4

cyclegraph: add documentation
---

diff --git a/cyclegraph.cc b/cyclegraph.cc
index 23e5eca..3bb5ab8 100644
--- a/cyclegraph.cc
+++ b/cyclegraph.cc
@@ -295,6 +295,7 @@ bool CycleGraph::checkReachable(const CycleNode *from, const CycleNode *to) cons
 	return false;
 }
 
+/** @return True, if the promise has failed; false otherwise */
 bool CycleGraph::checkPromise(const ModelAction *fromact, Promise *promise) const
 {
 	std::vector< CycleNode *, ModelAlloc<CycleNode *> > queue;