From: Brian Demsky <bdemsky@uci.edu>
Date: Wed, 6 Jun 2012 09:16:04 +0000 (-0700)
Subject: more comments
X-Git-Tag: pldi2013~391^2~42
X-Git-Url: http://plrg.eecs.uci.edu/git/?p=model-checker.git;a=commitdiff_plain;h=40212bad619f289d5c5ae944da42c80af249763d

more comments
---

diff --git a/main.cc b/main.cc
index be4c58d..66ad9f1 100644
--- a/main.cc
+++ b/main.cc
@@ -1,3 +1,7 @@
+/** @file main.cc
+ *  @brief Entry point for the model checker.
+ */
+
 #include "libthreads.h"
 #include "common.h"
 #include "threads.h"
@@ -6,9 +10,11 @@
 #include "model.h"
 #include "snapshot-interface.h"
 
-/*
- * Return 1 if found next thread, 0 otherwise
+/** The thread_system_next function takes the next step in the
+ *  execution.  @return Returns the 1 if there is another step and 0
+ *  otherwise.
  */
+
 static int thread_system_next(void) {
 	Thread *curr, *next;
 
@@ -32,12 +38,19 @@ static int thread_system_next(void) {
 	return Thread::swap(model->get_system_context(), next);
 }
 
+/** The thread_wait_finish method runs the current execution until we
+ *  have no more steps to take.
+ */
+
 static void thread_wait_finish(void) {
 	DBG();
 
 	while (!thread_system_next());
 }
 
+
+/** The real_main function contains the main model checking loop. */
+
 void real_main() {
 	thrd_t user_thread;
 	ucontext_t main_context;
@@ -71,8 +84,9 @@ void real_main() {
 int main_numargs;
 char ** main_args;
 
-/*
- * Main system function
+/**
+ * Main function.  Just initializes snapshotting library and the
+ * snapshotting library calls the real_main function.
  */
 int main(int numargs, char ** args) {
 	/* Stash this stuff in case someone wants it eventually */
diff --git a/snapshot.cc b/snapshot.cc
index a5792e5..afe02ef 100644
--- a/snapshot.cc
+++ b/snapshot.cc
@@ -44,6 +44,10 @@ static snapshot_id snapshotid = 0;
 #endif
 /* Initialize snapshot data structure */
 #if USE_MPROTECT_SNAPSHOT
+
+/** The initSnapShotRecord method initialized the snapshotting data
+ *  structures for the mprotect based snapshot. 
+ */
 void initSnapShotRecord(unsigned int numbackingpages, unsigned int numsnapshots, unsigned int nummemoryregions) {
 	snapshotrecord=( struct SnapShot * )MYMALLOC(sizeof(struct SnapShot));
 	snapshotrecord->regionsToSnapShot=( struct MemoryRegion * )MYMALLOC(sizeof(struct MemoryRegion)*nummemoryregions);
@@ -327,6 +331,8 @@ void rollBack( snapshot_id theID ){
 }
 
 /** The finalize method shuts down the snapshotting system.  */
+//Subramanian -- remove this function from the external interface and
+//have us call it internally
 
 void finalize(){
 #if !USE_MPROTECT_SNAPSHOT