cyclegraph: add documentation

diff --git a/cyclegraph.cc b/cyclegraph.cc
index 23e5eca4ec82d28d07393ba7cab344d0837920fd..3bb5ab84a88c240d11ee5b7ae1ed01d2ab7c7207 100644 (file)
--- 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;