Received: by 10.223.185.116 with SMTP id b49csp1033976wrg; Fri, 16 Feb 2018 11:11:13 -0800 (PST) X-Google-Smtp-Source: AH8x224+oQAGwCq7S+kTmrXnCpcGP/XoUtaXiprB8wfP9083ADW86gQQSab2MzSDCCgCOxoNMMvW X-Received: by 2002:a17:902:7c84:: with SMTP id y4-v6mr6651578pll.305.1518808273788; Fri, 16 Feb 2018 11:11:13 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1518808273; cv=none; d=google.com; s=arc-20160816; b=ASiqwiQ/B3JETatKOFRV4mt9Xg0EPFVd5b+Qn+4ssoyTpUvkVfj2Z5nBx0XysQ9p8k jRp65foRug8wVIMaZnUp4zOPixLcU23YBdkjRagimDGr8z/2MeCH+lnKMgOHCATEBlXz ZSlmv6eOB1IvraaMMzZDFF/mlI6RChRvPkhtQxqzEkm2ePmCpEB0vnBYmCU4VDJBhlhp 3VSje7h0xOQynAWSRbdDcMbLRqino68kOhY8Jk7R5eli6KDpmUJWetl+w2YNZm10qOP7 hS9htCVFsnr9nPs+CoRcRdZ47ksdS4ZzfsD/iX9/EPEJORwygz6S/SHuIbUye3pW48vt LbNg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:references:in-reply-to:references :in-reply-to:message-id:date:subject:cc:to:from :arc-authentication-results; bh=ujzaJ+e3JKMyCm1bjPifT0YIFA+fbZHsnEp/2tmU0zY=; b=clGEmtuTjIUervvtUJz7MmBscRsaVzWyNWSRoyI5oWKv4GfW4iAyx13rsy+NvD63Ak rUMOTQHpvSDCC+/m9thM7PhoCAnXugtC8M96Xcj1yuhAZWI8mZS1+pbvuZZHd2dbA3tX uNSx9tS1xD6ADqZlI6EKZZE0t8vgiugRsjfTDQbWu0yjQS8tGF3q+MrPyv7F7vO34Zvh MI5xCDlMZkjruQVyQaoJx5FXuqwgeEuoNgYEe5qDnYUrwGz+pcZ6J8jOIG5yK/KweJqx 1+OoN0ZuACLIcqG6SmGTSj7/9XGIUrDlzQh9aBfr9A1LZ6VgpYdQWu22PaZjNo1AR/md K5cw== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id 64-v6si1699549plk.167.2018.02.16.11.10.58; Fri, 16 Feb 2018 11:11:13 -0800 (PST) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1032497AbeBPNsg (ORCPT + 99 others); Fri, 16 Feb 2018 08:48:36 -0500 Received: from osg.samsung.com ([64.30.133.232]:48914 "EHLO osg.samsung.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1032356AbeBPNsc (ORCPT ); Fri, 16 Feb 2018 08:48:32 -0500 Received: from localhost (localhost [127.0.0.1]) by osg.samsung.com (Postfix) with ESMTP id C65DA34674; Fri, 16 Feb 2018 05:48:31 -0800 (PST) X-Virus-Scanned: Debian amavisd-new at dev.s-opensource.com X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References" Received: from osg.samsung.com ([127.0.0.1]) by localhost (localhost [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id Hvm8IvL-FHFO; Fri, 16 Feb 2018 05:48:30 -0800 (PST) Received: from smtp.s-opensource.com (177.17.248.146.dynamic.adsl.gvt.net.br [177.17.248.146]) by osg.samsung.com (Postfix) with ESMTPSA id 816803462E; Fri, 16 Feb 2018 05:48:27 -0800 (PST) Received: from mchehab by smtp.s-opensource.com with local (Exim 4.89) (envelope-from ) id 1emgNE-0002xf-VQ; Fri, 16 Feb 2018 11:48:24 -0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Jani Nikula , Matthew Wilcox , Tom Saeger Subject: [PATCH 5/6] doc-guide: kernel-doc: add examples about nested union/structs Date: Fri, 16 Feb 2018 11:48:19 -0200 Message-Id: <2629d8c4efede896db674159f643d7a54bd96a1b.1518788761.git.mchehab@s-opensource.com> X-Mailer: git-send-email 2.14.3 In-Reply-To: References: In-Reply-To: References: Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org It helps to give some examples about how to use in-line comments also when nested union/structs are present. So add it. Signed-off-by: Mauro Carvalho Chehab --- Documentation/doc-guide/kernel-doc.rst | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index 1ddfe35c0e78..c6c329708d8a 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -286,8 +286,17 @@ on a line of their own, like all other kernel-doc comments:: * Here, the member description may contain several paragraphs. */ int baz; - /** @foobar: Single line description. */ - int foobar; + union { + /** @foobar: Single line description. */ + int foobar; + }; + /** @bar2: Description for struct @bar2 inside @foo */ + struct { + /** + * @bar2.barbar: Description for @barbar inside @foo.bar2 + */ + int barbar; + } bar2; }; Typedef documentation -- 2.14.3