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 17871C433B4 for ; Wed, 7 Apr 2021 13:57:07 +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 B8C9361394 for ; Wed, 7 Apr 2021 13:57:06 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org B8C9361394 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=xen.org 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.106687.203987 (Exim 4.92) (envelope-from ) id 1lU8fx-0004dA-VL; Wed, 07 Apr 2021 13:56:57 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 106687.203987; Wed, 07 Apr 2021 13:56:57 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1lU8fx-0004d3-R4; Wed, 07 Apr 2021 13:56:57 +0000 Received: by outflank-mailman (input) for mailman id 106687; Wed, 07 Apr 2021 13:56:56 +0000 Received: from mail.xenproject.org ([104.130.215.37]) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1lU8fw-0004cy-EZ for xen-devel@lists.xenproject.org; Wed, 07 Apr 2021 13:56:56 +0000 Received: from xenbits.xenproject.org ([104.239.192.120]) by mail.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1lU8ft-0006P8-MR; Wed, 07 Apr 2021 13:56:53 +0000 Received: from 54-240-197-233.amazon.com ([54.240.197.233] helo=a483e7b01a66.ant.amazon.com) by xenbits.xenproject.org with esmtpsa (TLS1.3:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.92) (envelope-from ) id 1lU8ft-0007zl-Dt; Wed, 07 Apr 2021 13:56:53 +0000 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" DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=xen.org; s=20200302mail; h=Content-Transfer-Encoding:Content-Type:In-Reply-To: MIME-Version:Date:Message-ID:From:References:Cc:To:Subject; bh=q0sXYJJ0N701qo2FkTnn8uS6pjJvXlCPOrgmgY1xugo=; b=ld4rxmol5AuyMZHtVX2s3iYQWn /bcop5tbfgFn0PNzzekGAhf0O3Us6h4NZVTWP7znuHBuDiek1jluk3ugHLQjGI/bY9p/Ug+aWSEZg 1M7r+Pnv3BqsX7Ef7jxyQybEZsRdoQGU8+7PMur83AxCizmWW2dDBPkbqE7KJmbuMGjU=; Subject: Re: [PATCH 3/3] docs/doxygen: doxygen documentation for grant_table.h To: Luca Fancellu Cc: xen-devel@lists.xenproject.org, Bertrand Marquis , wei.chen@arm.com, Andrew Cooper , George Dunlap , Ian Jackson , Jan Beulich , Stefano Stabellini , Wei Liu 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> From: Julien Grall Message-ID: Date: Wed, 7 Apr 2021 14:56:51 +0100 User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:78.0) Gecko/20100101 Thunderbird/78.9.0 MIME-Version: 1.0 In-Reply-To: <0F20064C-418C-4A4F-9883-4452A726B038@arm.com> Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-GB Content-Transfer-Encoding: 8bit Hi Luca, On 07/04/2021 14:19, Luca Fancellu wrote: > > >> On 7 Apr 2021, at 14:13, Julien Grall 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