atomic.h: Fix doxygen errors
- @v & @i need to be @param v & @param i
- add the @file command
Change-Id: Ib4fb609629bc2dfcf1869bdf7a4d4cd9fea283cc
Signed-off-by: Martin Roth <martin.roth@se-eng.com>
Reviewed-on: http://review.coreboot.org/8075
Reviewed-by: Edward O'Callaghan <eocallaghan@alterapraxis.com>
Tested-by: build bot (Jenkins)
diff --git a/src/include/smp/atomic.h b/src/include/smp/atomic.h
index 44be4c5..bc50534 100644
--- a/src/include/smp/atomic.h
+++ b/src/include/smp/atomic.h
@@ -9,20 +9,24 @@
#define ATOMIC_INIT(i) { (i) }
/**
+ * @file include/smp/atomic.h
+ */
+
+/**
* atomic_read - read atomic variable
- * @v: pointer of type atomic_t
+ * @param v: pointer of type atomic_t
*
- * Atomically reads the value of @v. Note that the guaranteed
+ * Atomically reads the value of v. Note that the guaranteed
* useful range of an atomic_t is only 24 bits.
*/
#define atomic_read(v) ((v)->counter)
/**
* atomic_set - set atomic variable
- * @v: pointer of type atomic_t
- * @i: required value
+ * @param v: pointer of type atomic_t
+ * @param i: required value
*
- * Atomically sets the value of @v to @i. Note that the guaranteed
+ * Atomically sets the value of v to i. Note that the guaranteed
* useful range of an atomic_t is only 24 bits.
*/
#define atomic_set(v,i) (((v)->counter) = (i))
@@ -30,9 +34,9 @@
/**
* atomic_inc - increment atomic variable
- * @v: pointer of type atomic_t
+ * @param v: pointer of type atomic_t
*
- * Atomically increments @v by 1. Note that the guaranteed
+ * Atomically increments v by 1. Note that the guaranteed
* useful range of an atomic_t is only 24 bits.
*/
#define atomic_inc(v) (((v)->counter)++)
@@ -40,9 +44,9 @@
/**
* atomic_dec - decrement atomic variable
- * @v: pointer of type atomic_t
+ * @param v: pointer of type atomic_t
*
- * Atomically decrements @v by 1. Note that the guaranteed
+ * Atomically decrements v by 1. Note that the guaranteed
* useful range of an atomic_t is only 24 bits.
*/
#define atomic_dec(v) (((v)->counter)--)