linux-fbdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: daniel.thompson@linaro.org, jingoohan1@gmail.com,
	dri-devel@lists.freedesktop.org, linux-fbdev@vger.kernel.org
Cc: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>,
	linux-kernel@vger.kernel.org, stable@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org,
	Lee Jones <lee.jones@linaro.org>,
	Software Engineering <sbabic@denx.de>
Subject: [PATCH 3/8] backlight: ili922x: Add missing kerneldoc descriptions for CHECK_FREQ_REG() args
Date: Wed, 24 Jun 2020 14:57:16 +0000	[thread overview]
Message-ID: <20200624145721.2590327-4-lee.jones@linaro.org> (raw)
In-Reply-To: <20200624145721.2590327-1-lee.jones@linaro.org>

Kerneldoc syntax is used, but not complete.  Descriptions required.

Prevents warnings like:

 drivers/video/backlight/ili922x.c:116: warning: Function parameter or member 's' not described in 'CHECK_FREQ_REG'
 drivers/video/backlight/ili922x.c:116: warning: Function parameter or member 'x' not described in 'CHECK_FREQ_REG'

Cc: <stable@vger.kernel.org>
Cc: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>
Cc: Software Engineering <sbabic@denx.de>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/video/backlight/ili922x.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/drivers/video/backlight/ili922x.c b/drivers/video/backlight/ili922x.c
index 9c5aa3fbb2842..8cb4b9d3c3bba 100644
--- a/drivers/video/backlight/ili922x.c
+++ b/drivers/video/backlight/ili922x.c
@@ -107,6 +107,8 @@
  *	lower frequency when the registers are read/written.
  *	The macro sets the frequency in the spi_transfer structure if
  *	the frequency exceeds the maximum value.
+ * @s: pointer to controller side proxy for an SPI slave device
+ * @x: pointer to the read/write buffer pair
  */
 #define CHECK_FREQ_REG(s, x)	\
 	do {			\
-- 
2.25.1

  parent reply	other threads:[~2020-06-24 14:57 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-06-24 14:57 [PATCH 0/8] Fix a bunch of W=1 warnings in Backlight Lee Jones
2020-06-24 14:57 ` [PATCH 1/8] backlight: lms501kf03: Remove unused const variables Lee Jones
2020-06-25  9:24   ` Daniel Thompson
2020-06-24 14:57 ` [PATCH 2/8] backlight: lcd: Add missing kerneldoc entry for 'struct device parent' Lee Jones
2020-06-25  9:28   ` Daniel Thompson
2020-06-24 14:57 ` Lee Jones [this message]
2020-06-25  9:40   ` [PATCH 3/8] backlight: ili922x: Add missing kerneldoc descriptions for CHECK_FREQ_REG() args Daniel Thompson
2020-06-25 10:33     ` Lee Jones
2020-06-26  9:54       ` Daniel Thompson
2020-06-26 15:33         ` Lee Jones
2020-07-06  7:12     ` Lee Jones
2020-06-24 14:57 ` [PATCH 4/8] backlight: ili922x: Remove invalid use of kerneldoc syntax Lee Jones
2020-06-25  9:41   ` Daniel Thompson
2020-06-24 14:57 ` [PATCH 5/8] backlight: ili922x: Add missing kerneldoc description for ili922x_reg_dump()'s arg Lee Jones
2020-06-25  9:43   ` Daniel Thompson
2020-07-06  7:13     ` Lee Jones
2020-06-24 14:57 ` [PATCH 6/8] backlight: backlight: Supply description for function args in existing Kerneldocs Lee Jones
2020-06-25  9:43   ` Daniel Thompson
2020-06-24 14:57 ` [PATCH 7/8] backlight: lm3630a_bl: Remove invalid checks for unsigned int < 0 Lee Jones
2020-06-25  9:45   ` Daniel Thompson
2020-06-24 14:57 ` [PATCH 8/8] backlight: qcom-wled: Remove unused configs for LED3 and LED4 Lee Jones
2020-06-25  9:46   ` Daniel Thompson
2020-06-24 15:32 ` [PATCH 0/8] Fix a bunch of W=1 warnings in Backlight Sam Ravnborg
2020-06-24 15:43   ` Lee Jones
2020-06-24 16:24     ` Sam Ravnborg
2020-06-25  8:03       ` Lee Jones
2020-06-25 18:57         ` Sam Ravnborg
2020-07-06  7:13 ` 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=20200624145721.2590327-4-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=b.zolnierkie@samsung.com \
    --cc=daniel.thompson@linaro.org \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=jingoohan1@gmail.com \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-fbdev@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=sbabic@denx.de \
    --cc=stable@vger.kernel.org \
    /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).