[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h


  • To: Julien Grall <julien@xxxxxxx>
  • From: Luca Fancellu <luca.fancellu@xxxxxxx>
  • Date: Wed, 7 Apr 2021 14:19:58 +0100
  • Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=arm.com; dmarc=pass action=none header.from=arm.com; dkim=pass header.d=arm.com; arc=none
  • Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=kEebKDub3F8KWGtdwDqIa3AZxv2AKbsuXHCG8kU85nI=; b=aY9k6dHa97scoFvkjRFzCszYc/S4jbaWknanShii72BR3kgBOgUfayJk3OOLAtoht0nq/Racc0SC261hBIM2MqHkLmFCOCt8eltFWmZ16q98UviQaVpiM0rh6FgX7RsCBPu3cZYdRydc2Dva5HmAHFsQqD6Lq+4n2K5cjp3e7xzp0pa74+hu8ytFYwHKXC4oWtRfwszSFDPqzPMxSkteZOKoQ8Ld9yTMxkzyypJ0KPfBk9Oe+u88rjv1PQ7+MjySVvP7qa6VZeM7Jt/AqMSNjjlRfLx8KC6yTwtRNorOLIm216QHsPCsRZ2JX4ftK8eGX8K91F5jdv/NfNkJo0mUCQ==
  • Arc-seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=jOdfWtrD9dEaDhbRgfdBdPyqnkROrYz8xY6R5zU+OFf0YqXS9ta6HWGVNnpDA9BONm1y5dVgcOs6MldRWpfz+DeWkQGnZpWccowmOP4F/yFBx/vMy6HU+BKf/xoROd+bWixYmnaFzQdiI1PdO0jKS3VpdsJ4sDrJ6IddK3B4omtWiczt2jvcJhrDP2HqgsprucJftWv9Y9NbnZHHWAIVSTzGYiMyht+nLmQkmBUznQEbpJklBg3CCl7TVNzI3VbFOUMB5BxHh8UIgt7hvIJI6ZPSHFgct8fTCT9U26+iMbX4XGoOoefBxActQTzXQCacp937UZSI7qyAp6mM8YIGPg==
  • Authentication-results-original: xen.org; dkim=none (message not signed) header.d=none;xen.org; dmarc=none action=none header.from=arm.com;
  • Cc: xen-devel@xxxxxxxxxxxxxxxxxxxx, Bertrand Marquis <bertrand.marquis@xxxxxxx>, wei.chen@xxxxxxx, Andrew Cooper <andrew.cooper3@xxxxxxxxxx>, George Dunlap <george.dunlap@xxxxxxxxxx>, Ian Jackson <iwj@xxxxxxxxxxxxxx>, Jan Beulich <jbeulich@xxxxxxxx>, Stefano Stabellini <sstabellini@xxxxxxxxxx>, Wei Liu <wl@xxxxxxx>
  • Delivery-date: Wed, 07 Apr 2021 13:20:43 +0000
  • List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
  • Nodisclaimer: true
  • Original-authentication-results: xen.org; dkim=none (message not signed) header.d=none;xen.org; dmarc=none action=none header.from=arm.com;


> On 7 Apr 2021, at 14:13, Julien Grall <julien@xxxxxxx> wrote:
> 
> Hi,
> 
> On 06/04/2021 11:36, Luca Fancellu wrote:
>> Modification to include/public/grant_table.h:
>> 1) Change anonymous structure to be named structure,
>>    because doxygen can't deal with them.
> 
> What do you mean by can't deal with them? I had a quick try with doxygen 
> build and couldn't find any failure (although I haven't looked at the output).
> 

Hi Julien,

The problem is that Doxygen can’t generate proper documentation for anonymous 
union/structure, it ends up with warning and/or producing wrong documentation 
like
changing names or giving field description to the wrong field.

Cheers,
Luca

> Cheers,
> 
> -- 
> Julien Grall




 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.