Some grammatical fixups and additions to atomic.h kernel-doc content

Tweak and add content for extractable documentation in asm-i386/atomic.h.

Signed-off-by: Robert P. J. Day <rpjday@mindspring.com>
Acked-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Robert P. J. Day
2007-05-08 00:35:08 -07:00
committed by Linus Torvalds
parent 0ba34e197a
commit cc38682f35

View File

@@ -52,7 +52,7 @@ static __inline__ void atomic_add(int i, atomic_t *v)
} }
/** /**
* atomic_sub - subtract the atomic variable * atomic_sub - subtract integer from atomic variable
* @i: integer value to subtract * @i: integer value to subtract
* @v: pointer of type atomic_t * @v: pointer of type atomic_t
* *
@@ -171,7 +171,7 @@ static __inline__ int atomic_add_negative(int i, atomic_t *v)
} }
/** /**
* atomic_add_return - add and return * atomic_add_return - add integer and return
* @v: pointer of type atomic_t * @v: pointer of type atomic_t
* @i: integer value to add * @i: integer value to add
* *
@@ -203,6 +203,13 @@ no_xadd: /* Legacy 386 processor */
#endif #endif
} }
/**
* atomic_sub_return - subtract integer and return
* @v: pointer of type atomic_t
* @i: integer value to subtract
*
* Atomically subtracts @i from @v and returns @v - @i
*/
static __inline__ int atomic_sub_return(int i, atomic_t *v) static __inline__ int atomic_sub_return(int i, atomic_t *v)
{ {
return atomic_add_return(-i,v); return atomic_add_return(-i,v);