Martin Roth (gaumless@gmail.com) just uploaded a new patch set to gerrit, which you can find at http://review.coreboot.org/8075
-gerrit
commit bf8fa4da34f9ba33640f9cca7bcd03be33a5210a Author: Martin Roth martin.roth@se-eng.com Date: Mon Dec 29 22:36:06 2014 -0700
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 --- src/arch/x86/include/arch/smp/atomic.h | 21 +++++++++++---------- src/include/smp/atomic.h | 22 +++++++++++++--------- 2 files changed, 24 insertions(+), 19 deletions(-)
diff --git a/src/arch/x86/include/arch/smp/atomic.h b/src/arch/x86/include/arch/smp/atomic.h index 18bbae2..d7964e5 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) 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 @@ typedef struct { int counter; } atomic_t; #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 @@ typedef struct { int counter; } atomic_t;
/** * 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 @@ typedef struct { int counter; } atomic_t;
/** * 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)--)
-
Martin Roth