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.
Unified · Split
| @@ -167,21 +167,24 @@ struct gpio_irq_chip { · 166 unmodified lines | ||
| 167 | 167 | */ |
| 168 | 168 | irq_flow_handler_t parent_handler; |
| 169 | 169 | |
| 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 | − */ | |
| 183 | 170 | 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 | + */ | |
| 184 | 178 | 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 | + */ | |
| 185 | 188 | void **parent_handler_data_array; |
| 186 | 189 | }; |
| 187 | 190 | |