[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: Luca Fancellu <luca.fancellu@xxxxxxx>
- From: Julien Grall <julien@xxxxxxx>
- Date: Wed, 7 Apr 2021 14:56:51 +0100
- 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:56:58 +0000
- List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
Hi Luca,
On 07/04/2021 14:19, Luca Fancellu wrote:
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.
I might do something wrong because I cannot spot any significant
difference in the doxygen ouput if I switch back to anonymous union.
Would you mind to post more details (such as a diff) on how doxygen
doesn't generate properly documentation?
Cheers,
--
Julien Grall
|
