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

clocksource/drivers/stm32: Fix all kernel-doc warnings

Add a "Returns:" section in one function description.
Use the correct function name in another function description.

These changes prevent 2 warnings:

timer-stm32.c:79: warning: No description found for return value of 'stm32_timer_of_bits_get'
timer-stm32.c:189: warning: expecting prototype for stm32_timer_width(). Prototype was for stm32_timer_set_width() instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Daniel Lezcano <daniel.lezcano@linaro.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Fabrice Gasnier <fabrice.gasnier@foss.st.com>
Cc: linux-stm32@st-md-mailman.stormreply.com
Cc: linux-arm-kernel@lists.infradead.org
Signed-off-by: Daniel Lezcano <daniel.lezcano@linaro.org>
Link: https://lore.kernel.org/r/20240120173615.14618-1-rdunlap@infradead.org

authored by

Randy Dunlap and committed by
Daniel Lezcano
906fed29 f253c9a1

+2 -2
+2 -2
drivers/clocksource/timer-stm32.c
··· 73 73 * Accessor helper to get the number of bits in the timer-of private 74 74 * structure. 75 75 * 76 - * Returns an integer corresponding to the number of bits. 76 + * Returns: an integer corresponding to the number of bits. 77 77 */ 78 78 static int stm32_timer_of_bits_get(struct timer_of *to) 79 79 { ··· 177 177 } 178 178 179 179 /** 180 - * stm32_timer_width - Sort out the timer width (32/16) 180 + * stm32_timer_set_width - Sort out the timer width (32/16) 181 181 * @to: a pointer to a timer-of structure 182 182 * 183 183 * Write the 32-bit max value and read/return the result. If the timer