Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

time: tick-oneshot: Add missing Return and parameter descriptions to kernel-doc

Several functions in kernel/time/tick-oneshot.c are missing parameter and
return value descriptions in their kernel-doc comments. This causes
warnings during doc generation.

Update the kernel-doc blocks to include detailed @param and Return:
descriptions for better clarity and to fix kernel-doc warnings. No
functional code changes are made.

Signed-off-by: Sunday Adelodun <adelodunolaoluwa@yahoo.com>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Link: https://patch.msgid.link/20251106113938.34693-3-adelodunolaoluwa@yahoo.com

authored by

Sunday Adelodun and committed by
Thomas Gleixner
e54dd047 4702f4ec

+19 -1
+19 -1
kernel/time/tick-oneshot.c
··· 19 19 20 20 /** 21 21 * tick_program_event - program the CPU local timer device for the next event 22 + * @expires: the time at which the next timer event should occur 23 + * @force: flag to force reprograming even if the event time hasn't changed 24 + * 25 + * Return: 0 on success, negative error code on failure 22 26 */ 23 27 int tick_program_event(ktime_t expires, int force) 24 28 { ··· 61 57 62 58 /** 63 59 * tick_setup_oneshot - setup the event device for oneshot mode (hres or nohz) 60 + * @newdev: Pointer to the clock event device to configure 61 + * @handler: Function to be called when the event device triggers an interrupt 62 + * @next_event: Initial expiry time for the next event (in ktime) 63 + * 64 + * Configures the specified clock event device for onshot mode, 65 + * assigns the given handler as its event callback, and programs 66 + * the device to trigger at the specified next event time. 64 67 */ 65 68 void tick_setup_oneshot(struct clock_event_device *newdev, 66 69 void (*handler)(struct clock_event_device *), ··· 80 69 81 70 /** 82 71 * tick_switch_to_oneshot - switch to oneshot mode 72 + * @handler: function to call when an event occurs on the tick device 73 + * 74 + * Return: 0 on success, -EINVAL if the tick device is not present, 75 + * not functional, or does not support oneshot mode. 83 76 */ 84 77 int tick_switch_to_oneshot(void (*handler)(struct clock_event_device *)) 85 78 { ··· 116 101 /** 117 102 * tick_oneshot_mode_active - check whether the system is in oneshot mode 118 103 * 119 - * returns 1 when either nohz or highres are enabled. otherwise 0. 104 + * Return: 1 when either nohz or highres are enabled, otherwise 0. 120 105 */ 121 106 int tick_oneshot_mode_active(void) 122 107 { ··· 135 120 * tick_init_highres - switch to high resolution mode 136 121 * 137 122 * Called with interrupts disabled. 123 + * 124 + * Return: 0 on success, -EINVAL if the tick device cannot switch 125 + * to oneshot/high-resolution mode. 138 126 */ 139 127 int tick_init_highres(void) 140 128 {