[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: Ian Jackson <iwj@xxxxxxxxxxxxxx>
- From: Bertrand Marquis <Bertrand.Marquis@xxxxxxx>
- Date: Wed, 7 Apr 2021 15:29:30 +0000
- Accept-language: en-GB, en-US
- 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=RTcgAXVwCqNox34jIT4HgM+H69u0P79QsDwUG8MPVjE=; b=K1KkOkGlGMq2t7PGOz3X1CEiy9oUdxeUOK09Bu5T/9t0lPPPHBae0VGVU2ibA1wOuduUWeK/n5rh2+o9bWqGBkOWRQB6Vc6p4hPNc97ZeXGCn/lWWWZVi9HsGpPLIgDavNQBpG+lmDLB1qaUGXSeFo2tbzJ00xZh5ZZOW717EpfBgRH+2ti52Wx72x6VoD0+RhT0+sEQCqOzoPrimuKfp0G+FTZQNt7M5vS9w2tuYI8rnPCa/Q1OlybGcpkWRT+BHW5kNasPZkJrkxmubgGdpKPAZDX40gpxn1R1rCrnf3obIVi4FtcW/GZUXjWWnA4SpmPLcIRK9KkBfD6HwPHQPA==
- Arc-seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=mWSANXiyIVWUca7L4eTcL3mKwuNRwZRIxy119OYgYnbBAiv5NqBzVup3gh7tC/gGdzSptunQImBdV9RD58gzPP5/QEw/PQB3geMTP1dR9dKe2qGjUKwVivnvasnJZtmtZ98661+0g/tca4C1Yfx9lvjpT8S67Ys3BEkXMbraaO0mMlPGY32enbaI0jd3OOo6kKxsUWexCsnFbQnU+cGhVy19090YECqu7feZ8Xwpk6W3rDOGdQYgU46R4NXNuZr8oTAgEbv52A+KHXJK3rBPOyFeDzWmnWAsJhZXyCP4/NJLuozi8qgfRC6gx9wsq+V9WsUJ04nQyMsXPg/AYaE2tA==
- Authentication-results-original: xenproject.org; dkim=none (message not signed) header.d=none;xenproject.org; dmarc=none action=none header.from=arm.com;
- Cc: Luca Fancellu <Luca.Fancellu@xxxxxxx>, Julien Grall <julien@xxxxxxx>, "xen-devel@xxxxxxxxxxxxxxxxxxxx" <xen-devel@xxxxxxxxxxxxxxxxxxxx>, Wei Chen <Wei.Chen@xxxxxxx>, Andrew Cooper <andrew.cooper3@xxxxxxxxxx>, George Dunlap <george.dunlap@xxxxxxxxxx>, Jan Beulich <jbeulich@xxxxxxxx>, Stefano Stabellini <sstabellini@xxxxxxxxxx>, Wei Liu <wl@xxxxxxx>
- Delivery-date: Wed, 07 Apr 2021 15:30:04 +0000
- List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
- Nodisclaimer: true
- Original-authentication-results: xenproject.org; dkim=none (message not signed) header.d=none;xenproject.org; dmarc=none action=none header.from=arm.com;
- Thread-index: AQHXKtDW6d1uIaHDNEirYTRFGCHHX6qpCgoAgAABvgCAACFYgIAAAteA
- Thread-topic: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h
Hi Ian,
> On 7 Apr 2021, at 16:19, Ian Jackson <iwj@xxxxxxxxxxxxxx> 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 ?
If we agree on names or on a convention for name the result will not impact the
code or backward compatibility.
Regards
Bertrand
>
> Ian.
|
