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

Commit 9f4533cd authored by Thomas Gleixner's avatar Thomas Gleixner
Browse files

timerqueue: Document return values of timerqueue_add/del() 



The return values of timerqueue_add/del() are not documented in the kernel doc
comment. Add proper documentation.

Signed-off-by: default avatarThomas 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
parent fd45bb77

lib/timerqueue.c

+5 −3
Original line number Diff line number Diff line
@@ -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)

{