gpio: Fix kernel-doc comments to nested union
authorAkira Yokosawa <akiyks@gmail.com>
Mon, 6 Jun 2022 04:44:24 +0000 (13:44 +0900)
committerBartosz Golaszewski <brgl@bgdev.pl>
Thu, 23 Jun 2022 20:17:43 +0000 (22:17 +0200)
commitc7e1c443584ddd7facffca00e9e23b0d084e5bb3
tree1922246049fcce3ac699d3cf0c57bd7efa864309
parentc1c2a15c2b5379ea8e44dcdcc298e3de42076ba0
gpio: Fix kernel-doc comments to nested union

Commit 48ec13d36d3f ("gpio: Properly document parent data union")
is supposed to have fixed a warning from "make htmldocs" regarding
kernel-doc comments to union members.  However, the same warning
still remains [1].

Fix the issue by following the example found in section "Nested
structs/unions" of Documentation/doc-guide/kernel-doc.rst.

Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Fixes: 48ec13d36d3f ("gpio: Properly document parent data union")
Link: https://lore.kernel.org/r/20220606093302.21febee3@canb.auug.org.au/
Cc: Linus Walleij <linus.walleij@linaro.org>
Cc: Bartosz Golaszewski <brgl@bgdev.pl>
Cc: Joey Gouly <joey.gouly@arm.com>
Cc: Marc Zyngier <maz@kernel.org>
Tested-by: Stephen Rothwell <sfr@canb.auug.org.au>
Reviewed-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Signed-off-by: Bartosz Golaszewski <brgl@bgdev.pl>
include/linux/gpio/driver.h