cyclegraph: add documentation
authorBrian Norris <banorris@uci.edu>
Tue, 5 Feb 2013 06:50:45 +0000 (22:50 -0800)
committerBrian Norris <banorris@uci.edu>
Wed, 6 Feb 2013 21:44:39 +0000 (13:44 -0800)
cyclegraph.cc

index 23e5eca..3bb5ab8 100644 (file)
@@ -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;