move more configurables and add documentation

[model-checker.git] / nodestack.cc

diff --git a/nodestack.cc b/nodestack.cc
index 1de51693eea6ecd606fe3fd616536fa152cfdc4f..409c4e1e52ba431b729ec4b1c6d95168cfbc675b 100644 (file)
--- a/nodestack.cc
+++ b/nodestack.cc
@@ -77,6 +77,11 @@ bool Node::backtrack_empty()
        return (numBacktracks == 0);
 }
 
+
+/**
+ * Checks whether the readsfrom set for this node is empty.
+ * @return true if the readsfrom set is empty.
+ */
 bool Node::readsfrom_empty() {
        return ((read_from_index+1)>=may_read_from.size());
 }
@@ -109,7 +114,7 @@ bool Node::set_backtrack(thread_id_t id)
 
 thread_id_t Node::get_next_backtrack()
 {
-       /* TODO: find next backtrack */
+       /** @todo Find next backtrack */
        unsigned int i;
        for (i = 0; i < backtrack.size(); i++)
                if (backtrack[i] == true)
@@ -148,6 +153,10 @@ const ModelAction * Node::get_read_from() {
        return may_read_from[read_from_index];
 }
 
+/**
+ * Increments the index into the readsfrom set to explore the next item.
+ * @return Returns false if we have explored all items.
+ */
 bool Node::increment_read_from() {
        read_from_index++;
        return (read_from_index<may_read_from.size());
@@ -225,7 +234,8 @@ ModelAction * NodeStack::explore_action(ModelAction *act)
  * destructor for each. This function is provided an offset which determines
  * how many nodes (relative to the current replay state) to save before popping
  * the stack.
- * @param numAhead The number of nodes to skip forward before popping the stack.
+ * @param numAhead gives the number of Nodes (including this Node) to skip over
+ * before removing nodes.
  */
 void NodeStack::pop_restofstack(int numAhead)
 {