Skip to content

Commit c7e1c44

Browse files
akiyksbrgl
authored andcommitted
gpio: Fix kernel-doc comments to nested union
Commit 48ec13d ("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: 48ec13d ("gpio: Properly document parent data union") Link: https://lore.kernel.org/r/20220606093302.21febee3@canb.auug.org.au/ [1] 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>
1 parent c1c2a15 commit c7e1c44

1 file changed

Lines changed: 16 additions & 13 deletions

File tree

include/linux/gpio/driver.h

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -167,21 +167,24 @@ struct gpio_irq_chip {
167167
*/
168168
irq_flow_handler_t parent_handler;
169169

170-
/**
171-
* @parent_handler_data:
172-
*
173-
* If @per_parent_data is false, @parent_handler_data is a single
174-
* pointer used as the data associated with every parent interrupt.
175-
*
176-
* @parent_handler_data_array:
177-
*
178-
* If @per_parent_data is true, @parent_handler_data_array is
179-
* an array of @num_parents pointers, and is used to associate
180-
* different data for each parent. This cannot be NULL if
181-
* @per_parent_data is true.
182-
*/
183170
union {
171+
/**
172+
* @parent_handler_data:
173+
*
174+
* If @per_parent_data is false, @parent_handler_data is a
175+
* single pointer used as the data associated with every
176+
* parent interrupt.
177+
*/
184178
void *parent_handler_data;
179+
180+
/**
181+
* @parent_handler_data_array:
182+
*
183+
* If @per_parent_data is true, @parent_handler_data_array is
184+
* an array of @num_parents pointers, and is used to associate
185+
* different data for each parent. This cannot be NULL if
186+
* @per_parent_data is true.
187+
*/
185188
void **parent_handler_data_array;
186189
};
187190

0 commit comments

Comments
 (0)