Re: [PATCH 3/5] include/hw/qdev-core: fixup kerneldoc annotations (!COMPLETE)

[Richard Henderson]

On 6/19/23 19:14, Alex Bennée wrote:
> Fix up the kerneldoc markup and start documenting the various fields
> in QDEV related structures. Unfortunately this is not enough include
> the documentation because kerneldoc currently chokes on some of our
> macros such as:
>
>      /**
>       * @gpios: list of named GPIOs the device provides.
>       */
>      QLIST_HEAD(, NamedGPIOList) gpios;
>
> where it demands we document QLIST_HEAD and NamedGPIOList despite them
> not technically being fields in the structure.
>
> Signed-off-by: Alex Bennée<alex.bennee@linaro.org>
> ---
>   include/hw/qdev-core.h | 123 ++++++++++++++++++++++++++++++++++-------
>   1 file changed, 102 insertions(+), 21 deletions(-)

I wonder if e.g.

  typedef QLIST_HEAD(, NamedGPIOList) NamedGPIOListHead;

outside of struct DeviceClass would help with those.

Anyway, for this patch,

Reviewed-by: Richard Henderson <richard.henderson@linaro.org>


r~