From 4da2859902f1096053a2d9857df502d3bb94e6e4 Mon Sep 17 00:00:00 2001
From: Brian Norris <banorris@uci.edu>
Date: Mon, 4 Feb 2013 22:50:45 -0800
Subject: [PATCH] cyclegraph: add documentation

---
 cyclegraph.cc | 1 +
 1 file changed, 1 insertion(+)

diff --git a/cyclegraph.cc b/cyclegraph.cc
index 23e5eca4..3bb5ab84 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;
-- 
2.34.1