X-Git-Url: http://plrg.eecs.uci.edu/git/?p=model-checker.git;a=blobdiff_plain;f=action.h;h=111ac31124ef89d796e8d163c1b39a097c9a2c7c;hp=f9c6d417084e62d39956ad1b1775c236b7bc48b8;hb=9209688c955f7924af15da0c79c70948eb481b8c;hpb=c0182a11fd62cc38f9f5cbe49960d7a9bce8d381

diff --git a/action.h b/action.h
index f9c6d41..111ac31 100644
--- a/action.h
+++ b/action.h
@@ -15,14 +15,17 @@
 
 #define VALUE_NONE -1
 
+/** @brief Represents an action type, identifying one of several types of
+ * ModelAction */
 typedef enum action_type {
-	THREAD_CREATE,
-	THREAD_YIELD,
-	THREAD_JOIN,
-	ATOMIC_READ,
-	ATOMIC_WRITE,
-	ATOMIC_RMW,
-	ATOMIC_INIT
+	THREAD_CREATE,        /**< A thread creation action */
+	THREAD_YIELD,         /**< A thread yield action */
+	THREAD_JOIN,          /**< A thread join action */
+	ATOMIC_READ,          /**< An atomic read action */
+	ATOMIC_WRITE,         /**< An atomic write action */
+	ATOMIC_RMW,           /**< An atomic read-modify-write action */
+	ATOMIC_INIT           /**< Initialization of an atomic object (e.g.,
+	                       *   atomic_init()) */
 } action_type_t;
 
 /* Forward declaration */