Skip to content

Commit 906fed2

Browse files
rddunlapdlezcano
authored andcommitted
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
1 parent f253c9a commit 906fed2

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

drivers/clocksource/timer-stm32.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ static void stm32_timer_of_bits_set(struct timer_of *to, int bits)
7373
* Accessor helper to get the number of bits in the timer-of private
7474
* structure.
7575
*
76-
* Returns an integer corresponding to the number of bits.
76+
* Returns: an integer corresponding to the number of bits.
7777
*/
7878
static int stm32_timer_of_bits_get(struct timer_of *to)
7979
{
@@ -177,7 +177,7 @@ static irqreturn_t stm32_clock_event_handler(int irq, void *dev_id)
177177
}
178178

179179
/**
180-
* stm32_timer_width - Sort out the timer width (32/16)
180+
* stm32_timer_set_width - Sort out the timer width (32/16)
181181
* @to: a pointer to a timer-of structure
182182
*
183183
* Write the 32-bit max value and read/return the result. If the timer

0 commit comments

Comments
 (0)