document some enumerated types

[c11tester.git] / libatomic.h

diff --git a/libatomic.h b/libatomic.h
index 1806f21968b75405c1675a9456b4e79afa6f421f..71482c3d0a505d050fafc912951d8c084ee7fac6 100644 (file)
--- a/libatomic.h
+++ b/libatomic.h
@@ -1,3 +1,7 @@
+/** @file libatomic.h
+ *  @brief Basic atomic operations to be exposed to user program.
+ */
+
 #ifndef __LIBATOMIC_H__
 #define __LIBATOMIC_H__
 
@@ -5,6 +9,7 @@
 extern "C" {
 #endif
 
+       /** @brief The memory orders specified by the C11/C++11 memory models */
        typedef enum memory_order {
                memory_order_relaxed,
                memory_order_consume,