Skip to content

Commit 5dc6470

Browse files
rddunlapjernejsk
authored andcommitted
clk: sunxi-ng: fix ccu_mmc_timing.c kernel-doc issues
Use '-' to separate the function name and its description. Use '%' on constants in kernel-doc notation. Use the kernel-doc Return: format for function return values. Fixes this warning: ccu_mmc_timing.c:21: warning: No description found for return value of 'sunxi_ccu_set_mmc_timing_mode' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Yang Li <yang.lee@linux.alibaba.com> Cc: Chen-Yu Tsai <wens@csie.org> Cc: Jernej Skrabec <jernej.skrabec@gmail.com> Cc: Samuel Holland <samuel@sholland.org> Cc: linux-arm-kernel@lists.infradead.org Cc: linux-sunxi@lists.linux.dev Cc: Michael Turquette <mturquette@baylibre.com> Cc: Stephen Boyd <sboyd@kernel.org> Cc: linux-clk@vger.kernel.org Acked-by: Jernej Skrabec <jernej.skrabec@gmail.com> Reviewed-by: Stephen Boyd <sboyd@kernel.org> Link: https://lore.kernel.org/r/20221122184844.6794-1-rdunlap@infradead.org Signed-off-by: Jernej Skrabec <jernej.skrabec@gmail.com>
1 parent 1b929c0 commit 5dc6470

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

drivers/clk/sunxi-ng/ccu_mmc_timing.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010
#include "ccu_common.h"
1111

1212
/**
13-
* sunxi_ccu_set_mmc_timing_mode: Configure the MMC clock timing mode
13+
* sunxi_ccu_set_mmc_timing_mode - Configure the MMC clock timing mode
1414
* @clk: clock to be configured
1515
* @new_mode: true for new timing mode introduced in A83T and later
1616
*
17-
* Returns 0 on success, -ENOTSUPP if the clock does not support
17+
* Return: %0 on success, %-ENOTSUPP if the clock does not support
1818
* switching modes.
1919
*/
2020
int sunxi_ccu_set_mmc_timing_mode(struct clk *clk, bool new_mode)
@@ -46,8 +46,8 @@ EXPORT_SYMBOL_GPL(sunxi_ccu_set_mmc_timing_mode);
4646
* sunxi_ccu_set_mmc_timing_mode: Get the current MMC clock timing mode
4747
* @clk: clock to query
4848
*
49-
* Returns 0 if the clock is in old timing mode, > 0 if it is in
50-
* new timing mode, and -ENOTSUPP if the clock does not support
49+
* Return: %0 if the clock is in old timing mode, > %0 if it is in
50+
* new timing mode, and %-ENOTSUPP if the clock does not support
5151
* this function.
5252
*/
5353
int sunxi_ccu_get_mmc_timing_mode(struct clk *clk)

0 commit comments

Comments
 (0)