Document caa_container_of

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>

diff --git a/urcu/compiler.h b/urcu/compiler.h
index 489677b3aefe1ad6dd294006d903721f375f66a7..f8fce5a6b46558fa4a4b2d50f78f91eecf229c90 100644 (file)
--- a/urcu/compiler.h
+++ b/urcu/compiler.h
@@ -55,9 +55,16 @@
 #define CAA_BITS_PER_LONG      32
 #endif
 
-#define caa_container_of(ptr, type, member)                                    \
+/*
+ * caa_container_of - Get the address of an object containing a field.
+ *
+ * @ptr: pointer to the field.
+ * @type: type of the object.
+ * @member: name of the field within the object.
+ */
+#define caa_container_of(ptr, type, member)                            \
        ({                                                              \
-               const typeof(((type *)NULL)->member) * __ptr = (ptr);   \
+               const typeof(((type *) NULL)->member) * __ptr = (ptr);  \
                (type *)((char *)__ptr - offsetof(type, member));       \
        })