include/: add small header comments
authorBrian Norris <banorris@uci.edu>
Thu, 11 Oct 2012 17:28:22 +0000 (10:28 -0700)
committerBrian Norris <banorris@uci.edu>
Thu, 11 Oct 2012 17:28:22 +0000 (10:28 -0700)
include/atomic
include/cstdatomic
include/impatomic.h
include/memoryorder.h
include/stdatomic.h

index 5219837..5984e72 100644 (file)
@@ -1,3 +1,8 @@
+/**
+ * @file atomic
+ * @brief C++11 atomic interface header
+ */
+
 #ifndef __CXX_ATOMIC__
 #define __CXX_ATOMIC__
 
index 8bbd988..b441097 100644 (file)
@@ -1,3 +1,7 @@
+/**
+ * @file cstdatomic
+ * @brief C11 atomic interface header
+ */
 
 #include "impatomic.h"
 
index ae0796f..889a960 100644 (file)
@@ -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__
 
index 93e87a0..8c4c2a0 100644 (file)
@@ -1,3 +1,8 @@
+/**
+ * @file memoryorder.h
+ * @brief C11/C++11 atomic memory order listings
+ */
+
 #ifndef MEMORYORDER_H
 #define MEMORYORDER_H
 #ifdef __cplusplus
index 035f848..7b3ff80 100644 (file)
@@ -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__ */