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

[Jan Beulich <jbeulich@xxxxxxxx>]

On 07.04.2021 17:29, Bertrand Marquis wrote:
>> 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 ?

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?

Jan