Commit 906fed29 authored by Randy Dunlap's avatar Randy Dunlap Committed by Daniel Lezcano

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: default avatarRandy 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: default avatarDaniel Lezcano <daniel.lezcano@linaro.org>
Link: https://lore.kernel.org/r/20240120173615.14618-1-rdunlap@infradead.org
parent f253c9a1
...@@ -73,7 +73,7 @@ static void stm32_timer_of_bits_set(struct timer_of *to, int bits) ...@@ -73,7 +73,7 @@ static void stm32_timer_of_bits_set(struct timer_of *to, int bits)
* Accessor helper to get the number of bits in the timer-of private * Accessor helper to get the number of bits in the timer-of private
* structure. * structure.
* *
* Returns an integer corresponding to the number of bits. * Returns: an integer corresponding to the number of bits.
*/ */
static int stm32_timer_of_bits_get(struct timer_of *to) static int stm32_timer_of_bits_get(struct timer_of *to)
{ {
...@@ -177,7 +177,7 @@ static irqreturn_t stm32_clock_event_handler(int irq, void *dev_id) ...@@ -177,7 +177,7 @@ static irqreturn_t stm32_clock_event_handler(int irq, void *dev_id)
} }
/** /**
* stm32_timer_width - Sort out the timer width (32/16) * stm32_timer_set_width - Sort out the timer width (32/16)
* @to: a pointer to a timer-of structure * @to: a pointer to a timer-of structure
* *
* Write the 32-bit max value and read/return the result. If the timer * Write the 32-bit max value and read/return the result. If the timer
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment