From 24e2e951b91dd2e177f2ff133362e0cc0cf6b505 Mon Sep 17 00:00:00 2001 From: Martin Roth Date: Mon, 29 Dec 2014 22:36:06 -0700 Subject: 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 Reviewed-on: http://review.coreboot.org/8075 Reviewed-by: Edward O'Callaghan Tested-by: build bot (Jenkins) --- src/arch/x86/include/arch/smp/atomic.h | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) (limited to 'src/arch') diff --git a/src/arch/x86/include/arch/smp/atomic.h b/src/arch/x86/include/arch/smp/atomic.h index 18bbae27cb..d7964e5feb 100644 --- a/src/arch/x86/include/arch/smp/atomic.h +++ b/src/arch/x86/include/arch/smp/atomic.h @@ -10,35 +10,36 @@ typedef struct { volatile int counter; } atomic_t; #define ATOMIC_INIT(i) { (i) } -/* +/** @file x86/include/arch/smp/atomic.h + * * Atomic operations that C can't guarantee us. Useful for * resource counting etc.. */ /** * 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)) /** * 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. */ static __inline__ __attribute__((always_inline)) void atomic_inc(atomic_t *v) @@ -51,9 +52,9 @@ static __inline__ __attribute__((always_inline)) void atomic_inc(atomic_t *v) /** * 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. */ static __inline__ __attribute__((always_inline)) void atomic_dec(atomic_t *v) -- cgit v1.2.3