fix my todo comments so they appear in documentation

diff --git a/action.cc b/action.cc
index f0ad48feaf731d808f69212b5926170e4ce96905..33c69656d7702d757cd90d44a5884fdef99e2864 100644 (file)
--- 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 de8f10c0c3efb9d0d8e0cd660b61633b79e10e46..a9d76c66a1e86b746d22da4b7505966355ffb660 100644 (file)
--- 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 e8f377b51a6dfbca7e59dc69b1a81a5b19cac196..409c4e1e52ba431b729ec4b1c6d95168cfbc675b 100644 (file)
--- 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 792014e62b4d3c88c1ecc052a4de120c25cace52..399472c9ac60b5b578ea0af88ea05bcf7da06c9f 100644 (file)
--- 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));