timerqueue: Document return values of timerqueue_add/del()

KAGA-KOKO · KAGA-KOKO · commit 9f4533cd7334 · 2017-12-29T23:13:10.000+01:00
The return values of timerqueue_add/del() are not documented in the kernel doc comment. Add proper documentation. Signed-off-by: Thomas Gleixner <tglx@linutronix.de> Cc: Peter Zijlstra <peterz@infradead.org> Cc: Frederic Weisbecker <fweisbec@gmail.com> Cc: Sebastian Siewior <bigeasy@linutronix.de> Cc: rt@linutronix.de Cc: Paul McKenney <paulmck@linux.vnet.ibm.com> Cc: Anna-Maria Gleixner <anna-maria@linutronix.de> Link: https://lkml.kernel.org/r/20171222145337.872681338@linutronix.de
diff --git a/lib/timerqueue.c b/lib/timerqueue.c
@@ -33,8 +33,9 @@
  * @head: head of timerqueue
  * @node: timer node to be added
  *
- * Adds the timer node to the timerqueue, sorted by the
- * node's expires value.
+ * Adds the timer node to the timerqueue, sorted by the node's expires
+ * value. Returns true if the newly added timer is the first expiring timer in
+ * the queue.
  */
 bool timerqueue_add(struct timerqueue_head *head, struct timerqueue_node *node)
 {
@@ -70,7 +71,8 @@ EXPORT_SYMBOL_GPL(timerqueue_add);
  * @head: head of timerqueue
  * @node: timer node to be removed
  *
- * Removes the timer node from the timerqueue.
+ * Removes the timer node from the timerqueue. Returns true if the queue is
+ * not empty after the remove.
  */
 bool timerqueue_del(struct timerqueue_head *head, struct timerqueue_node *node)
 {

Original file line number	Diff line number	Diff line change
`@@ -33,8 +33,9 @@`
`33`	`33`	`* @head: head of timerqueue`
`34`	`34`	`* @node: timer node to be added`
`35`	`35`	`*`
`36`		`- * Adds the timer node to the timerqueue, sorted by the`
`37`		`- * node's expires value.`
	`36`	`+ * Adds the timer node to the timerqueue, sorted by the node's expires`
	`37`	`+ * value. Returns true if the newly added timer is the first expiring timer in`
	`38`	`+ * the queue.`
`38`	`39`	`*/`
`39`	`40`	`bool timerqueue_add(struct timerqueue_head head, struct timerqueue_node node)`
`40`	`41`	`{`
`@@ -70,7 +71,8 @@ EXPORT_SYMBOL_GPL(timerqueue_add);`
`70`	`71`	`* @head: head of timerqueue`
`71`	`72`	`* @node: timer node to be removed`
`72`	`73`	`*`
`73`		`- * Removes the timer node from the timerqueue.`
	`74`	`+ * Removes the timer node from the timerqueue. Returns true if the queue is`
	`75`	`+ * not empty after the remove.`
`74`	`76`	`*/`
`75`	`77`	`bool timerqueue_del(struct timerqueue_head head, struct timerqueue_node node)`
`76`	`78`	`{`