[PATCH] timers: add missing kernel-doc

[Randy Dunlap]

From: Randy Dunlap <randy.dunlap@xxxxxxxxxx>

Add missing kernel-doc parameter notation and change function
name to its new name:

Warning(kernel/timer.c:543): No description found for parameter 'name'
Warning(kernel/timer.c:543): No description found for parameter 'key'

Signed-off-by: Randy Dunlap <randy.dunlap@xxxxxxxxxx>
cc: Johannes Berg <johannes@xxxxxxxxxxxxxxxx>
---
 kernel/timer.c |    7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

--- linux-2.6.29-git8.orig/kernel/timer.c
+++ linux-2.6.29-git8/kernel/timer.c
@@ -531,10 +531,13 @@ static void __init_timer(struct timer_li
 }
 
 /**
- * init_timer - initialize a timer.
+ * init_timer_key - initialize a timer
  * @timer: the timer to be initialized
+ * @name: name of the timer
+ * @key: lockdep class key of the fake lock used for tracking timer
+ *       sync lock dependencies
  *
- * init_timer() must be done to a timer prior calling *any* of the
+ * init_timer_key() must be done to a timer prior calling *any* of the
  * other timer functions.
  */
 void init_timer_key(struct timer_list *timer,
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/