Received-SPF: pass (google.com: domain of linux-kernel+bounces-12094-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Date: Wed, 27 Dec 2023 17:54:50 +0200 (EET)
From: =?ISO-8859-15?Q?Ilpo_J=E4rvinen?= <ilpo.jarvinen@linux.intel.com>
To: Andy Shevchenko <andriy.shevchenko@intel.com>
cc: linux-pci@vger.kernel.org, Bjorn Helgaas <bhelgaas@google.com>, 
    Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>, 
    Rob Herring <robh@kernel.org>, 
    =?ISO-8859-2?Q?Krzysztof_Wilczy=F1ski?= <kw@linux.com>, 
    Igor Mammedov <imammedo@redhat.com>, Lukas Wunner <lukas@wunner.de>, 
    Mika Westerberg <mika.westerberg@linux.intel.com>, 
    "Rafael J . Wysocki" <rafael@kernel.org>, 
    LKML <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH 4/7] resource: Use typedef for alignf callback
In-Reply-To: <ZYWPaGc4rjymcm75@smile.fi.intel.com>
Message-ID: <8161e59d-2122-562c-dcc7-f772ddbcbdf@linux.intel.com>
References: <20231222122901.49538-1-ilpo.jarvinen@linux.intel.com> <20231222122901.49538-5-ilpo.jarvinen@linux.intel.com> <ZYWPaGc4rjymcm75@smile.fi.intel.com>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII

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.