Re: [PATCH 4/7] resource: Use typedef for alignf callback

Ilpo Järvinen
2023-12-27T15:54:56Z

On Fri, 22 Dec 2023, Andy Shevchenko wrote:

> > +/**
> > + * resource_alignf - Resource alignment callback
> > + * @data: Private data used by the callback
> > + * @res: Resource candidate range (an empty resource slot)
> > + * @size: The minimum size of the empty slot
> > + * @align: Alignment from the constraints
> > + *
> > + * Callback allows calculating resource placement and alignment beyond min,
> > + * max, and align fields in the struct resource_constraint.
> > + *
> > + * Return: Start address for the resource.
> > + */
> > +typedef resource_size_t (*resource_alignf)(void *data,
> > + const struct resource *res,
> > + resource_size_t size,
> > + resource_size_t align);
>
> Never saw typedef kernel-doc before, so hopefully this will be rendered
> just fine.

This was a good point. It seems that one has to prefix the name with
typedef like this:

/**
* typedef resource_alignf - Resource alignment callback

...otherwise scripts/kernel-doc attempts to parse it as a function
kerneldoc.

--
i.