nodestack: document pop_restofstack()

diff --git a/nodestack.cc b/nodestack.cc
index 5a65821188fa0698de88a3c03684abea0f12adc8..1de51693eea6ecd606fe3fd616536fa152cfdc4f 100644 (file)
--- a/nodestack.cc
+++ b/nodestack.cc
@@ -220,7 +220,13 @@ ModelAction * NodeStack::explore_action(ModelAction *act)
        return NULL;
 }
 
-
+/**
+ * Empties the stack of all trailing nodes after a given position and calls the
+ * 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.
+ */
 void NodeStack::pop_restofstack(int numAhead)
 {
        /* Diverging from previous execution; clear out remainder of list */
@@ -230,7 +236,6 @@ void NodeStack::pop_restofstack(int numAhead)
        clear_node_list(&node_list, it, node_list.end());
 }
 
-
 Node * NodeStack::get_head()
 {
        if (node_list.empty())