include/: add small header comments

diff --git a/include/atomic b/include/atomic
index 52198375aff4221a58d86326209216f5dc35e93d..5984e722b3f27fe008e6504137a26ac1b1a2d048 100644 (file)
--- 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 8bbd988406b09e1fa8d374967b39ef7cc6263432..b44109713697838f74f209647ae0e097ba932e01 100644 (file)
--- 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 ae0796f0da4100de7d6c7a04623fb1388002303b..889a960b3888a1beab03d3dc75c9acf92541ea79 100644 (file)
--- 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 93e87a037001fff1c6db234f1d459fa092eddb31..8c4c2a047c11df7c526495054458f9be4099a4d7 100644 (file)
--- 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 035f848d33b648eaad450e7c29d38b7b422c5060..7b3ff8004546e77e9e8996d521ebaf46e57aa994 100644 (file)
--- 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__ */