From: Brian Norris <banorris@uci.edu>
Date: Thu, 11 Oct 2012 17:28:22 +0000 (-0700)
Subject: include/: add small header comments
X-Git-Tag: pldi2013~53^2~2
X-Git-Url: http://plrg.eecs.uci.edu/git/?p=model-checker.git;a=commitdiff_plain;h=0b9a8924695870c15bc39feb6ec96d525954eaba;hp=89c68eaa8c88e6ff491a7611fdf94abddd7378ae

include/: add small header comments
---

diff --git a/include/atomic b/include/atomic
index 5219837..5984e72 100644
--- a/include/atomic
+++ b/include/atomic
@@ -1,3 +1,8 @@
+/**
+ * @file atomic
+ * @brief C++11 atomic interface header
+ */
+
 #ifndef __CXX_ATOMIC__
 #define __CXX_ATOMIC__
 
diff --git a/include/cstdatomic b/include/cstdatomic
index 8bbd988..b441097 100644
--- a/include/cstdatomic
+++ b/include/cstdatomic
@@ -1,3 +1,7 @@
+/**
+ * @file cstdatomic
+ * @brief C11 atomic interface header
+ */
 
 #include "impatomic.h"
 
diff --git a/include/impatomic.h b/include/impatomic.h
index ae0796f..889a960 100644
--- a/include/impatomic.h
+++ b/include/impatomic.h
@@ -1,3 +1,11 @@
+/**
+ * @file impatomic.h
+ * @brief Common header for C11/C++11 atomics
+ *
+ * Note that some features are unavailable, as they require support from a true
+ * C11/C++11 compiler.
+ */
+
 #ifndef __IMPATOMIC_H__
 #define __IMPATOMIC_H__
 
diff --git a/include/memoryorder.h b/include/memoryorder.h
index 93e87a0..8c4c2a0 100644
--- a/include/memoryorder.h
+++ b/include/memoryorder.h
@@ -1,3 +1,8 @@
+/**
+ * @file memoryorder.h
+ * @brief C11/C++11 atomic memory order listings
+ */
+
 #ifndef MEMORYORDER_H
 #define MEMORYORDER_H
 #ifdef __cplusplus
diff --git a/include/stdatomic.h b/include/stdatomic.h
index 035f848..7b3ff80 100644
--- a/include/stdatomic.h
+++ b/include/stdatomic.h
@@ -1,3 +1,8 @@
+/**
+ * @file stdatomic.h
+ * @brief C11 atomic interface header
+ */
+
 #ifndef __STDATOMIC_H__
 #define __STDATOMIC_H__
 
@@ -59,6 +64,6 @@ using std::memory_order_release;
 using std::memory_order_acq_rel;
 using std::memory_order_seq_cst;
 
-#endif
+#endif /* __cplusplus */
 
 #endif /* __STDATOMIC_H__ */