cyclegraph: add documentation

diff --git a/cyclegraph.cc b/cyclegraph.cc
index 2dc2eae9503a92f1117be1345441242d3a8f1437..8326f28b7ee3a2c3be6332fc383f959707040eac 100644 (file)
--- a/cyclegraph.cc
+++ b/cyclegraph.cc
@@ -317,6 +317,7 @@ unsigned int CycleNode::getNumBackEdges() const
 /**
  * Adds an edge from this CycleNode to another CycleNode.
  * @param node The node to which we add a directed edge
+ * @return True if this edge is a new edge; false otherwise
  */
 bool CycleNode::addEdge(CycleNode *node)
 {