From: Bertrand Marquis <Bertrand.Marquis@arm.com>
To: Jan Beulich <jbeulich@suse.com>
Cc: Luca Fancellu <Luca.Fancellu@arm.com>,
Julien Grall <julien@xen.org>,
"xen-devel@lists.xenproject.org" <xen-devel@lists.xenproject.org>,
Wei Chen <Wei.Chen@arm.com>,
Andrew Cooper <andrew.cooper3@citrix.com>,
George Dunlap <george.dunlap@citrix.com>,
Stefano Stabellini <sstabellini@kernel.org>, Wei Liu <wl@xen.org>,
Ian Jackson <iwj@xenproject.org>
Subject: Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h
Date: Wed, 7 Apr 2021 16:07:41 +0000 [thread overview]
Message-ID: <EAF4C93B-F35C-42DA-9AE2-4F1B8D238B25@arm.com> (raw)
In-Reply-To: <47b84686-faac-cfc4-44ae-d6f844bc7d0a@suse.com>
Hi,
> On 7 Apr 2021, at 16:54, Jan Beulich <jbeulich@suse.com> wrote:
>
> On 07.04.2021 17:29, Bertrand Marquis wrote:
>>> On 7 Apr 2021, at 16:19, Ian Jackson <iwj@xenproject.org> wrote:
>>>
>>> Luca Fancellu writes ("Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h"):
>>>> 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.
>>>
>>> This does not seem like it would be an impossibly hard feature to add
>>> to doxygen.
>>
>> Modifying doxygen is not really in our planned efforts and if someone does it that would put an hard constraint on the version of doxygen possible to use.
>>
>> But is adding names to anonymous elements really an issue here ?
>
> It's clutter in the code base, making things harder to read (even if
> just slightly). It's certainly odd to make such source changes just
> for a doc tool. If changing doxygen is not an option for you, how
> about pre-processing the header and inserting the names the tool
> wants, before handing the result as input to it?
Introducing a new tool or find a pre-processing solution is for sure possible
but will be more complex and less error prone.
Also as said in my mail to Julien, passing this issue of anonymous entries now
might just push the problem as we might have to solve it later if we want to become
MISRA compliant (which is also something we are looking in FuSa).
Regards
Bertrand
>
> Jan
>
next prev parent reply other threads:[~2021-04-07 16:08 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-06 10:36 [PATCH 0/3] Use Doxygen and sphinx for html documentation Luca Fancellu
2021-04-06 10:36 ` [PATCH 1/3] docs: add doxygen support " Luca Fancellu
2021-04-06 10:36 ` [PATCH 2/3] docs: hypercalls sphinx skeleton for generated html Luca Fancellu
2021-04-06 10:36 ` [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h Luca Fancellu
2021-04-06 11:19 ` Jan Beulich
2021-04-06 21:46 ` Stefano Stabellini
2021-04-07 8:10 ` Jan Beulich
2021-04-07 8:42 ` Luca Fancellu
2021-04-07 8:58 ` Jan Beulich
2021-04-07 21:26 ` Stefano Stabellini
2021-04-08 5:59 ` Jan Beulich
2021-04-08 11:02 ` Luca Fancellu
2021-04-08 11:28 ` Jan Beulich
2021-04-08 11:40 ` Julien Grall
2021-04-08 11:50 ` Julien Grall
2021-04-08 13:13 ` Luca Fancellu
2021-04-08 11:58 ` Luca Fancellu
2021-04-07 13:13 ` Julien Grall
2021-04-07 13:19 ` Luca Fancellu
2021-04-07 13:56 ` Julien Grall
2021-04-07 14:51 ` Luca Fancellu
2021-04-07 15:19 ` Ian Jackson
2021-04-07 15:29 ` Bertrand Marquis
2021-04-07 15:54 ` Jan Beulich
2021-04-07 16:07 ` Bertrand Marquis [this message]
2021-04-07 15:55 ` Julien Grall
2021-04-07 16:06 ` Bertrand Marquis
2021-04-07 16:12 ` Ian Jackson
2021-04-06 11:53 ` [PATCH 0/3] Use Doxygen and sphinx for html documentation Andrew Cooper
2021-04-06 21:24 ` Stefano Stabellini
2021-04-07 11:15 ` Andrew Cooper
2021-04-07 13:05 ` Bertrand Marquis
2021-04-07 13:07 ` Julien Grall
2021-04-07 13:16 ` Luca Fancellu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=EAF4C93B-F35C-42DA-9AE2-4F1B8D238B25@arm.com \
--to=bertrand.marquis@arm.com \
--cc=Luca.Fancellu@arm.com \
--cc=Wei.Chen@arm.com \
--cc=andrew.cooper3@citrix.com \
--cc=george.dunlap@citrix.com \
--cc=iwj@xenproject.org \
--cc=jbeulich@suse.com \
--cc=julien@xen.org \
--cc=sstabellini@kernel.org \
--cc=wl@xen.org \
--cc=xen-devel@lists.xenproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).