Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 45f8bde0 authored by Robert P. J. Day's avatar Robert P. J. Day Committed by Linus Torvalds
Browse files

[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: default avatarRobert P. J. Day <rpjday@mindspring.com>
Signed-off-by: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarAndrew Morton <akpm@osdl.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent a8d814b5

include/linux/bitops.h

+2 −4
Original line number Diff line number Diff line
@@ -31,9 +31,8 @@ static inline unsigned long hweight_long(unsigned long w) 
	return sizeof(w) == 4 ? hweight32(w) : hweight64(w);

}



/*

/**

 * rol32 - rotate a 32-bit value left

 *

 * @word: value to rotate

 * @shift: bits to roll

 */
@@ -42,9 +41,8 @@ static inline __u32 rol32(__u32 word, unsigned int shift) 
	return (word << shift) | (word >> (32 - shift));

}



/*

/**

 * ror32 - rotate a 32-bit value right

 *

 * @word: value to rotate

 * @shift: bits to roll

 */

include/linux/list.h

+5 −5
Original line number Diff line number Diff line
@@ -227,13 +227,13 @@ static inline void list_replace_init(struct list_head *old, 
	INIT_LIST_HEAD(old);

}



/*

/**

 * list_replace_rcu - replace old entry by new one

 * @old : the element to be replaced

 * @new : the new element to insert

 *

 * The old entry will be replaced with the new entry atomically.

 * Note: 'old' should not be empty.

 * The @old entry will be replaced with the @new entry atomically.

 * Note: @old should not be empty.

 */

static inline void list_replace_rcu(struct list_head *old,

				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

 * @old : the element to be replaced

 * @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,

					struct hlist_node *new)

include/linux/mutex.h

+1 −1
Original line number Diff line number Diff line
@@ -105,7 +105,7 @@ do { \ 
extern void __mutex_init(struct mutex *lock, const char *name,

			 struct lock_class_key *key);



/***

/**

 * mutex_is_locked - is the mutex locked

 * @lock: the mutex to be queried

 *

include/linux/rtmutex.h

+2 −2
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ 
#include <linux/plist.h>

#include <linux/spinlock_types.h>



/*

/**

 * The rt_mutex structure

 *

 * @wait_lock:	spinlock to protect the structure
@@ -71,7 +71,7 @@ struct hrtimer_sleeper; 
#define DEFINE_RT_MUTEX(mutexname) \

	struct rt_mutex mutexname = __RT_MUTEX_INITIALIZER(mutexname)



/***

/**

 * rt_mutex_is_locked - is the mutex locked

 * @lock: the mutex to be queried

 *

include/linux/timer.h

+2 −2
Original line number Diff line number Diff line
@@ -41,7 +41,7 @@ static inline void setup_timer(struct timer_list * timer, 
	init_timer(timer);

}



/***

/**

 * timer_pending - is a timer pending?

 * @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);



/***

/**

 * add_timer - start a timer

 * @timer: the timer to be added

 *