Add documentation

[c11tester.git] / cmodelint.cc

diff --git a/cmodelint.cc b/cmodelint.cc
index 4754a826800ab3cee4d6d32baf152905fb3d2d70..8919041be4589670d228ad3e3e7b00b7132a5f2b 100644 (file)
--- a/cmodelint.cc
+++ b/cmodelint.cc
@@ -1,28 +1,38 @@
 #include "model.h"
 #include "cmodelint.h"
 
+/** Performs a read action.*/
 uint64_t model_read_action(void * obj, memory_order ord) {
        model->switch_to_master(new ModelAction(ATOMIC_READ, ord, obj));
        return thread_current()->get_return_value();
 }
 
+/** Performs a write action.*/
 void model_write_action(void * obj, memory_order ord, uint64_t val) {
        model->switch_to_master(new ModelAction(ATOMIC_WRITE, ord, obj, val));
 }
 
+/** Performs an init action. */
 void model_init_action(void * obj, uint64_t val) {
        model->switch_to_master(new ModelAction(ATOMIC_INIT, memory_order_relaxed, obj, val));
 }
 
+/**
+ * Performs the read part of a RMW action. The next action must either be the
+ * write part of the RMW action or an explicit close out of the RMW action w/o
+ * a write.
+ */
 uint64_t model_rmwr_action(void *obj, memory_order ord) {
        model->switch_to_master(new ModelAction(ATOMIC_RMWR, ord, obj));
        return thread_current()->get_return_value();
 }
 
+/** Performs the write part of a RMW action. */
 void model_rmw_action(void *obj, memory_order ord, uint64_t val) {
        model->switch_to_master(new ModelAction(ATOMIC_RMW, ord, obj, val));
 }
 
+/** Closes out a RMW action without doing a write. */
 void model_rmwc_action(void *obj, memory_order ord) {
        model->switch_to_master(new ModelAction(ATOMIC_RMWC, ord, obj));
 }