From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.3 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, NICE_REPLY_A,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_SANE_1 autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 749AFC433B4 for ; Wed, 7 Apr 2021 15:55:02 +0000 (UTC) Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 3BFB861353 for ; Wed, 7 Apr 2021 15:55:02 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 3BFB861353 Authentication-Results: mail.kernel.org; dmarc=fail (p=quarantine dis=none) header.from=suse.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=xen-devel-bounces@lists.xenproject.org Received: from list by lists.xenproject.org with outflank-mailman.106789.204189 (Exim 4.92) (envelope-from ) id 1lUAW4-00005o-Oz; Wed, 07 Apr 2021 15:54:52 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 106789.204189; Wed, 07 Apr 2021 15:54:52 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1lUAW4-00005h-K0; Wed, 07 Apr 2021 15:54:52 +0000 Received: by outflank-mailman (input) for mailman id 106789; Wed, 07 Apr 2021 15:54:51 +0000 Received: from us1-rack-iad1.inumbo.com ([172.99.69.81]) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1lUAW2-00005c-W5 for xen-devel@lists.xenproject.org; Wed, 07 Apr 2021 15:54:51 +0000 Received: from mx2.suse.de (unknown [195.135.220.15]) by us1-rack-iad1.inumbo.com (Halon) with ESMTPS id a72bc8cd-ce91-4ed9-b9b7-e7e37118cf76; Wed, 07 Apr 2021 15:54:50 +0000 (UTC) Received: from relay2.suse.de (unknown [195.135.221.27]) by mx2.suse.de (Postfix) with ESMTP id 75AB4B166; Wed, 7 Apr 2021 15:54:49 +0000 (UTC) X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: a72bc8cd-ce91-4ed9-b9b7-e7e37118cf76 X-Virus-Scanned: by amavisd-new at test-mx.suse.de DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.com; s=susede1; t=1617810889; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=yiqCoEVimYSRXkNwTYt79fhQeMotr+3iW4qaWc8UQGw=; b=a68UZ29GOmAQqZAsSzXJodxdIONuZS1BSzI6nrDRGzmCrdPFVankQiX+S4vmqzKhfLB8u2 KaG2AgPfDe3DMziYrAdLCwwU34QH62+t8dgfB0277it9/joYmrN2N/Z0n8SoYQdBDRtOju XC1NTvrrDgCQxpUYTvXU9VMobU8lKwg= Subject: Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h To: Bertrand Marquis Cc: Luca Fancellu , Julien Grall , "xen-devel@lists.xenproject.org" , Wei Chen , Andrew Cooper , George Dunlap , Stefano Stabellini , Wei Liu , Ian Jackson References: <20210406103603.8530-1-luca.fancellu@arm.com> <20210406103603.8530-4-luca.fancellu@arm.com> <7f143615-acdf-5a97-5e07-57cab49031d6@xen.org> <0F20064C-418C-4A4F-9883-4452A726B038@arm.com> <24685.52599.234444.705703@mariner.uk.xensource.com> <03084EF9-F130-41F7-9D8D-9AF86A87717F@arm.com> From: Jan Beulich Message-ID: <47b84686-faac-cfc4-44ae-d6f844bc7d0a@suse.com> Date: Wed, 7 Apr 2021 17:54:48 +0200 User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:78.0) Gecko/20100101 Thunderbird/78.9.0 MIME-Version: 1.0 In-Reply-To: <03084EF9-F130-41F7-9D8D-9AF86A87717F@arm.com> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 8bit On 07.04.2021 17:29, Bertrand Marquis wrote: >> On 7 Apr 2021, at 16:19, Ian Jackson 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