The return values of timerqueue_add/del() are not documented in the kernel doc comment. Add proper documentation.
Showing the changes to lib/timerqueue.c (1 of 1 file). Show all
Unified · Split
| @@ -33,8 +33,9 @@ · 32 unmodified lines | |||
| 33 | * @head: head of timerqueue | 33 | * @head: head of timerqueue |
| 34 | * @node: timer node to be added | 34 | * @node: timer node to be added |
| 35 | * | 35 | * |
| 36 | * Adds the timer node to the timerqueue, sorted by the | 36 | * Adds the timer node to the timerqueue, sorted by the node's expires |
| 37 | * node's expires value. | 37 | * value. Returns true if the newly added timer is the first expiring timer in |
| 38 | * the queue. | ||
| 38 | */ | 39 | */ |
| 39 | bool timerqueue_add(struct timerqueue_head *head, struct timerqueue_node *node) | 40 | bool timerqueue_add(struct timerqueue_head *head, struct timerqueue_node *node) |
| 40 | { | 41 | { |
| @@ -70,7 +71,8 @@ EXPORT_SYMBOL_GPL(timerqueue_add); · 29 unmodified lines | |||
| 70 | * @head: head of timerqueue | 71 | * @head: head of timerqueue |
| 71 | * @node: timer node to be removed | 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 | bool timerqueue_del(struct timerqueue_head *head, struct timerqueue_node *node) | 77 | bool timerqueue_del(struct timerqueue_head *head, struct timerqueue_node *node) |
| 76 | { | 78 | { |