thread_id_t: add comments

[model-checker.git] / include / modeltypes.h

diff --git a/include/modeltypes.h b/include/modeltypes.h
index 22221cb5731a25c317d616bb79a8eb30cd961cdf..34525d2c8e1abc1aaeba97d53d3bbb0bc3808bd3 100644 (file)
--- a/include/modeltypes.h
+++ b/include/modeltypes.h
@@ -1,6 +1,24 @@
+/**
+ * @file modeltypes.h
+ * @brief Common typedefs for the model-checker
+ */
+
 #ifndef __MODELTYPES_H__
 #define __MODELTYPES_H__
 
+/**
+ * @brief Represents a unique ID for a Thread
+ *
+ * The space of unique IDs may need to become a non-compact
+ * or non-zero-indexed set of integers (or even some other
+ * type). So this typedef is used to help identify which is
+ * which, where a simple 'int' is meant to be a compact,
+ * zero-indexed set and a 'thread_id_t' may be another type
+ * entirely.
+ *
+ * @see id_to_int
+ * @see int_to_id
+ */
 typedef int thread_id_t;
 
 #define THREAD_ID_T_NONE       -1