document some enumerated types

[model-checker.git] / threads.h

diff --git a/threads.h b/threads.h
index ed9cbfed118a20561f271aaace5acc67f5b47f6e..0f39a836f49efae34c63415f433e37715a43d258 100644 (file)
--- a/threads.h
+++ b/threads.h
@@ -13,10 +13,19 @@ typedef int thread_id_t;
 
 #define THREAD_ID_T_NONE       -1
 
+/** @brief Represents the state of a user Thread */
 typedef enum thread_state {
+       /** Thread was just created and hasn't run yet */
        THREAD_CREATED,
+       /** Thread is running */
        THREAD_RUNNING,
+       /**
+        * Thread has yielded to the model-checker but is ready to run. Used
+        * during an action that caused a context switch to the model-checking
+        * context.
+        */
        THREAD_READY,
+       /** Thread has completed its execution */
        THREAD_COMPLETED
 } thread_state;