From: Brian Demsky <bdemsky@uci.edu>
Date: Fri, 20 Jul 2012 21:45:03 +0000 (-0700)
Subject: fix my todo comments so they appear in documentation
X-Git-Tag: pldi2013~313
X-Git-Url: http://plrg.eecs.uci.edu/git/?p=model-checker.git;a=commitdiff_plain;h=5e3720f6a6dccf2af670e4ab30660130f2a57c8f

fix my todo comments so they appear in documentation
---

diff --git a/action.cc b/action.cc
index f0ad48f..33c6965 100644
--- a/action.cc
+++ b/action.cc
@@ -103,11 +103,9 @@ void ModelAction::copy_typeandorder(ModelAction * act) {
 /** This method changes an existing read part of an RMW action into either:
  *  (1) a full RMW action in case of the completed write or
  *  (2) a READ action in case a failed action.
+ * @todo  If the memory_order changes, we may potentially need to update our
+ * clock vector.
  */
-
-//TODO:  If the memory_order changes, we may potentially need to update our
-//clock vector.
-
 void ModelAction::process_rmw(ModelAction * act) {
 	this->order=act->order;
 	if (act->is_rmwc())
@@ -127,7 +125,6 @@ void ModelAction::process_rmw(ModelAction * act) {
  *  @param act is the action to consider exploring a reordering.
  *  @return tells whether we have to explore a reordering.
  */
-
 bool ModelAction::is_synchronizing(const ModelAction *act) const
 {
 	//Same thread can't be reordered
diff --git a/model.cc b/model.cc
index de8f10c..a9d76c6 100644
--- a/model.cc
+++ b/model.cc
@@ -536,7 +536,7 @@ void ModelChecker::build_reads_from_past(ModelAction *curr)
 	}
 
 	if (!initialized) {
-		/* TODO: need a more informative way of reporting errors */
+		/** @todo Need a more informative way of reporting errors. */
 		printf("ERROR: may read from uninitialized atomic\n");
 	}
 
diff --git a/nodestack.cc b/nodestack.cc
index e8f377b..409c4e1 100644
--- a/nodestack.cc
+++ b/nodestack.cc
@@ -114,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)
diff --git a/threads.cc b/threads.cc
index 792014e..399472c 100644
--- a/threads.cc
+++ b/threads.cc
@@ -1,3 +1,8 @@
+/** @file threads.cc
+ *  @brief Thread functions.
+ */
+
+
 #include "libthreads.h"
 #include "common.h"
 #include "threads.h"
@@ -27,13 +32,13 @@ Thread * thread_current(void)
  * Provides a startup wrapper for each thread, allowing some initial
  * model-checking data to be recorded. This method also gets around makecontext
  * not being 64-bit clean
+ * @todo We should make the START event always immediately follow the
+ * CREATE event, so we don't get redundant traces...
  */
+
 void thread_startup() {
 	Thread * curr_thread = thread_current();
 
-	/* TODO -- we should make this event always immediately follow the
-		 CREATE event, so we don't get redundant traces...  */
-
 	/* Add dummy "start" action, just to create a first clock vector */
 	model->switch_to_master(new ModelAction(THREAD_START, std::memory_order_seq_cst, curr_thread));