[PATCH v3] gpio: EN7523: fix kernel-doc warnings

Randy Dunlap posted 1 patch 1 year, 11 months ago
drivers/gpio/gpio-en7523.c |    6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
[PATCH v3] gpio: EN7523: fix kernel-doc warnings
Posted by Randy Dunlap 1 year, 11 months ago
Add "struct" keyword and explain the @dir array differently to
prevent kernel-doc warnings:

gpio-en7523.c:22: warning: cannot understand function prototype: 'struct airoha_gpio_ctrl '
gpio-en7523.c:27: warning: Function parameter or struct member 'dir' not described in 'airoha_gpio_ctrl'
gpio-en7523.c:27: warning: Excess struct member 'dir0' description in 'airoha_gpio_ctrl'
gpio-en7523.c:27: warning: Excess struct member 'dir1' description in 'airoha_gpio_ctrl'

Fixes: 0868ad385aff ("gpio: Add support for Airoha EN7523 GPIO controller")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: John Crispin <john@phrozen.org>
Cc: Linus Walleij <linus.walleij@linaro.org>
Cc: Bartosz Golaszewski <brgl@bgdev.pl>
Cc: Felix Fietkau <nbd@nbd.name>
Cc: linux-gpio@vger.kernel.org
---
v2: Add commit text.
v3: add Fixes tag.

 drivers/gpio/gpio-en7523.c |    6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff -- a/drivers/gpio/gpio-en7523.c b/drivers/gpio/gpio-en7523.c
--- a/drivers/gpio/gpio-en7523.c
+++ b/drivers/gpio/gpio-en7523.c
@@ -12,11 +12,11 @@
 #define AIROHA_GPIO_MAX		32
 
 /**
- * airoha_gpio_ctrl - Airoha GPIO driver data
+ * struct airoha_gpio_ctrl - Airoha GPIO driver data
  * @gc: Associated gpio_chip instance.
  * @data: The data register.
- * @dir0: The direction register for the lower 16 pins.
- * @dir1: The direction register for the higher 16 pins.
+ * @dir: [0] The direction register for the lower 16 pins.
+ * [1]: The direction register for the higher 16 pins.
  * @output: The output enable register.
  */
 struct airoha_gpio_ctrl {
Re: [PATCH v3] gpio: EN7523: fix kernel-doc warnings
Posted by Bartosz Golaszewski 1 year, 11 months ago
On Mon, Jan 15, 2024 at 7:56 PM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> Add "struct" keyword and explain the @dir array differently to
> prevent kernel-doc warnings:
>
> gpio-en7523.c:22: warning: cannot understand function prototype: 'struct airoha_gpio_ctrl '
> gpio-en7523.c:27: warning: Function parameter or struct member 'dir' not described in 'airoha_gpio_ctrl'
> gpio-en7523.c:27: warning: Excess struct member 'dir0' description in 'airoha_gpio_ctrl'
> gpio-en7523.c:27: warning: Excess struct member 'dir1' description in 'airoha_gpio_ctrl'
>
> Fixes: 0868ad385aff ("gpio: Add support for Airoha EN7523 GPIO controller")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: John Crispin <john@phrozen.org>
> Cc: Linus Walleij <linus.walleij@linaro.org>
> Cc: Bartosz Golaszewski <brgl@bgdev.pl>
> Cc: Felix Fietkau <nbd@nbd.name>
> Cc: linux-gpio@vger.kernel.org
> ---

Applied, thanks!

Bart