UbiquitousOS
/
OpenCloudOS-Kernel
mirror of https://gitee.com/OpenCloudOS/OpenCloudOS-Kernel.git
11
0
Fork 0
Code Issues Projects Releases Wiki Activity

[PATCH] fix various kernel-doc in header files 

Fix a number of kernel-doc entries for header files in include/linux by
making sure they begin with the appropriate '/**' notation and use @var
notation.

Signed-off-by: Robert P. J. Day <rpjday@mindspring.com>
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Robert P. J. Day 2007-01-26 00:57:09 -08:00 committed by Linus Torvalds
parent a8d814b5dd
commit 45f8bde0d0
5 changed files with 12 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/linux/bitops.h
View File

@ -31,9 +31,8 @@ static inline unsigned long hweight_long(unsigned long w)
return sizeof(w) == 4 ? hweight32(w) : hweight64(w); return sizeof(w) == 4 ? hweight32(w) : hweight64(w);
} }
/* /**
* rol32 - rotate a 32-bit value left * rol32 - rotate a 32-bit value left
*
* @word: value to rotate * @word: value to rotate
* @shift: bits to roll * @shift: bits to roll
*/ */
@ -42,9 +41,8 @@ static inline __u32 rol32(__u32 word, unsigned int shift)
return (word << shift) | (word >> (32 - shift)); return (word << shift) | (word >> (32 - shift));
} }
/* /**
* ror32 - rotate a 32-bit value right * ror32 - rotate a 32-bit value right
*
* @word: value to rotate * @word: value to rotate
* @shift: bits to roll * @shift: bits to roll
*/ */

10
include/linux/list.h
View File

@ -227,13 +227,13 @@ static inline void list_replace_init(struct list_head *old,
INIT_LIST_HEAD(old); INIT_LIST_HEAD(old);
} }
/* /**
* list_replace_rcu - replace old entry by new one * list_replace_rcu - replace old entry by new one
* @old : the element to be replaced * @old : the element to be replaced
* @new : the new element to insert * @new : the new element to insert
* *
* The old entry will be replaced with the new entry atomically. * The @old entry will be replaced with the @new entry atomically.
* Note: 'old' should not be empty. * Note: @old should not be empty.
*/ */
static inline void list_replace_rcu(struct list_head *old, static inline void list_replace_rcu(struct list_head *old,
struct list_head *new) struct list_head *new)
@ -680,12 +680,12 @@ static inline void hlist_del_init(struct hlist_node *n)
} }
} }
/* /**
* hlist_replace_rcu - replace old entry by new one * hlist_replace_rcu - replace old entry by new one
* @old : the element to be replaced * @old : the element to be replaced
* @new : the new element to insert * @new : the new element to insert
* *
* The old entry will be replaced with the new entry atomically. * The @old entry will be replaced with the @new entry atomically.
*/ */
static inline void hlist_replace_rcu(struct hlist_node *old, static inline void hlist_replace_rcu(struct hlist_node *old,
struct hlist_node *new) struct hlist_node *new)

2
include/linux/mutex.h
View File

@ -105,7 +105,7 @@ do { \
extern void __mutex_init(struct mutex *lock, const char *name, extern void __mutex_init(struct mutex *lock, const char *name,
struct lock_class_key *key); struct lock_class_key *key);
/*** /**
* mutex_is_locked - is the mutex locked * mutex_is_locked - is the mutex locked
* @lock: the mutex to be queried * @lock: the mutex to be queried
* *

4
include/linux/rtmutex.h
View File

@ -16,7 +16,7 @@
#include <linux/plist.h> #include <linux/plist.h>
#include <linux/spinlock_types.h> #include <linux/spinlock_types.h>
/* /**
* The rt_mutex structure * The rt_mutex structure
* *
* @wait_lock: spinlock to protect the structure * @wait_lock: spinlock to protect the structure
@ -71,7 +71,7 @@ struct hrtimer_sleeper;
#define DEFINE_RT_MUTEX(mutexname) \ #define DEFINE_RT_MUTEX(mutexname) \
struct rt_mutex mutexname = __RT_MUTEX_INITIALIZER(mutexname) struct rt_mutex mutexname = __RT_MUTEX_INITIALIZER(mutexname)
/*** /**
* rt_mutex_is_locked - is the mutex locked * rt_mutex_is_locked - is the mutex locked
* @lock: the mutex to be queried * @lock: the mutex to be queried
* *

4
include/linux/timer.h
View File

@ -41,7 +41,7 @@ static inline void setup_timer(struct timer_list * timer,
init_timer(timer); init_timer(timer);
} }
/*** /**
* timer_pending - is a timer pending? * timer_pending - is a timer pending?
* @timer: the timer in question * @timer: the timer in question
* *
@ -63,7 +63,7 @@ extern int mod_timer(struct timer_list *timer, unsigned long expires);
extern unsigned long next_timer_interrupt(void); extern unsigned long next_timer_interrupt(void);
/*** /**
* add_timer - start a timer * add_timer - start a timer
* @timer: the timer to be added * @timer: the timer to be added
* *