linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org, Pavel Machek <pavel@ucw.cz>,
	Antonio Ospite <ospite@studenti.unina.it>,
	linux-leds@vger.kernel.org
Subject: [PATCH 08/15] leds: leds-lp3944: Provide missing function names in documentation headers
Date: Fri, 28 May 2021 10:06:22 +0100	[thread overview]
Message-ID: <20210528090629.1800173-9-lee.jones@linaro.org> (raw)
In-Reply-To: <20210528090629.1800173-1-lee.jones@linaro.org>

Fixes the following W=1 kernel build warning(s):

 drivers/leds/leds-lp3944.c:95: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/leds/leds-lp3944.c:126: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/leds/leds-lp3944.c:158: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

Cc: Pavel Machek <pavel@ucw.cz>
Cc: Antonio Ospite <ospite@studenti.unina.it>
Cc: linux-leds@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/leds/leds-lp3944.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/leds/leds-lp3944.c b/drivers/leds/leds-lp3944.c
index 838e6f19d37e5..437c711b2a27e 100644
--- a/drivers/leds/leds-lp3944.c
+++ b/drivers/leds/leds-lp3944.c
@@ -92,7 +92,7 @@ static int lp3944_reg_write(struct i2c_client *client, u8 reg, u8 value)
 }
 
 /**
- * Set the period for DIM status
+ * lp3944_dim_set_period() - Set the period for DIM status
  *
  * @client: the i2c client
  * @dim: either LP3944_DIM0 or LP3944_DIM1
@@ -123,7 +123,7 @@ static int lp3944_dim_set_period(struct i2c_client *client, u8 dim, u16 period)
 }
 
 /**
- * Set the duty cycle for DIM status
+ * lp3944_dim_set_dutycycle - Set the duty cycle for DIM status
  *
  * @client: the i2c client
  * @dim: either LP3944_DIM0 or LP3944_DIM1
@@ -155,7 +155,7 @@ static int lp3944_dim_set_dutycycle(struct i2c_client *client, u8 dim,
 }
 
 /**
- * Set the led status
+ * lp3944_led_set() - Set the led status
  *
  * @led: a lp3944_led_data structure
  * @status: one of LP3944_LED_STATUS_OFF
-- 
2.31.1


  parent reply	other threads:[~2021-05-28  9:07 UTC|newest]

Thread overview: 31+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-28  9:06 [PATCH 00/15] Rid W=1 warnings from LED Lee Jones
2021-05-28  9:06 ` [PATCH 01/15] leds: trigger: ledtrig-cpu: Fix incorrectly documented param 'ledevt' Lee Jones
2021-05-28 10:03   ` Alexander Dahl
2021-05-28  9:06 ` [PATCH 02/15] leds: leds-gpio-register: Supply description for param 'id' Lee Jones
2021-05-28  9:41   ` Uwe Kleine-König
2021-05-28  9:55     ` Lee Jones
2021-05-28 10:35       ` Uwe Kleine-König
2021-06-01  9:05         ` Lee Jones
2021-06-02  8:24           ` Uwe Kleine-König
2021-06-02  8:33             ` Alexander Dahl
2021-06-04  5:05               ` Uwe Kleine-König
2021-05-28  9:06 ` [PATCH 03/15] leds: led-class: Fix incorrectly documented param 'dev' Lee Jones
2021-05-28 10:10   ` Alexander Dahl
2021-06-01  9:05     ` Lee Jones
2021-05-28  9:06 ` [PATCH 04/15] leds: leds-bcm6328: Demote kernel-doc abuse Lee Jones
2021-05-28  9:06 ` [PATCH 05/15] leds: leds-as3645a: Fix function name 'as3645a_set_current()' Lee Jones
2021-05-28  9:31   ` Sakari Ailus
2021-05-28  9:40     ` Pavel Machek
2021-05-28  9:55       ` Lee Jones
2021-05-28  9:06 ` [PATCH 06/15] leds: leds-blinkm: Remove unused variable 'ret' Lee Jones
2021-05-28  9:06 ` [PATCH 07/15] leds: leds-is31fl32xx: Provide missing description for member 'sw_shutdown_func' Lee Jones
2021-05-28  9:06 ` Lee Jones [this message]
2021-05-28  9:06 ` [PATCH 09/15] leds: leds-lm3530: Fix incorrect spelling of 'brightness' Lee Jones
2021-05-28  9:06 ` [PATCH 10/15] leds: leds-lm3692x: Fix some kernel-doc formatting issues Lee Jones
2021-05-28  9:06 ` [PATCH 11/15] leds: leds-lm3697: Provide some missing descriptions for struct members Lee Jones
2021-05-28  9:06 ` [PATCH 12/15] leds: leds-mlxreg: Fix incorrect documentation of struct member 'led_cdev' and 'led_cdev_name' Lee Jones
2021-05-28  9:06 ` [PATCH 13/15] leds: leds-lp8860: Fix kernel-doc related formatting issues Lee Jones
2021-05-28  9:06 ` [PATCH 14/15] leds: leds-lm3692x: Demote non-complete kernel-doc Lee Jones
2021-05-28  9:39   ` Pavel Machek
2021-05-28  9:56     ` Lee Jones
2021-05-28  9:06 ` [PATCH 15/15] leds: leds-mlxcpld: Fix a bunch of kernel-doc formatting issues Lee Jones

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210528090629.1800173-9-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-leds@vger.kernel.org \
    --cc=ospite@studenti.unina.it \
    --cc=pavel@ucw.cz \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).