diff mbox series

rtc: ac100: remove misuses of kernel-doc

Message ID 20240114231320.31437-1-rdunlap@infradead.org
State Accepted
Headers show
Series rtc: ac100: remove misuses of kernel-doc | expand

Commit Message

Randy Dunlap Jan. 14, 2024, 11:13 p.m. UTC
Prevent kernel-doc warnings by changing "/**" to common comment
format "/*" in non-kernel-doc comments:

drivers/rtc/rtc-ac100.c:103: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Clock controls for 3 clock output pins
drivers/rtc/rtc-ac100.c:382: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * RTC related bits

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Chen-Yu Tsai <wens@csie.org>
Cc: Alexandre Belloni <alexandre.belloni@bootlin.com>
Cc: linux-rtc@vger.kernel.org
---
 drivers/rtc/rtc-ac100.c |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Alexandre Belloni Jan. 15, 2024, 9:28 p.m. UTC | #1
On Sun, 14 Jan 2024 15:13:20 -0800, Randy Dunlap wrote:
> Prevent kernel-doc warnings by changing "/**" to common comment
> format "/*" in non-kernel-doc comments:
> 
> drivers/rtc/rtc-ac100.c:103: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Clock controls for 3 clock output pins
> drivers/rtc/rtc-ac100.c:382: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * RTC related bits
> 
> [...]

Applied, thanks!

[1/1] rtc: ac100: remove misuses of kernel-doc
      commit: eea7615b684fc98cd0403beaaa2194e6f029c812

Best regards,
diff mbox series

Patch

diff -- a/drivers/rtc/rtc-ac100.c b/drivers/rtc/rtc-ac100.c
--- a/drivers/rtc/rtc-ac100.c
+++ b/drivers/rtc/rtc-ac100.c
@@ -99,7 +99,7 @@  struct ac100_rtc_dev {
 	struct clk_hw_onecell_data *clk_data;
 };
 
-/**
+/*
  * Clock controls for 3 clock output pins
  */
 
@@ -378,7 +378,7 @@  static void ac100_rtc_unregister_clks(st
 	clk_unregister_fixed_rate(chip->rtc_32k_clk->clk);
 }
 
-/**
+/*
  * RTC related bits
  */
 static int ac100_rtc_get_time(struct device *dev, struct rtc_time *rtc_tm)