Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932678AbcKQKXT (ORCPT ); Thu, 17 Nov 2016 05:23:19 -0500 Received: from mga07.intel.com ([134.134.136.100]:52318 "EHLO mga07.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751335AbcKQKXQ (ORCPT ); Thu, 17 Nov 2016 05:23:16 -0500 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.31,653,1473145200"; d="scan'208";a="787526574" From: Jani Nikula To: Daniel Vetter , LKML Cc: Daniel Vetter , Daniel Vetter , Jonathan Corbet , linux-doc@vger.kernel.org, Daniel Vetter Subject: Re: [PATCH] doc: Document the new inline struct member kernel-doc style In-Reply-To: <20161117101943.9137-1-daniel.vetter@ffwll.ch> Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo References: <20161117094312.7825-1-daniel.vetter@ffwll.ch> <20161117101943.9137-1-daniel.vetter@ffwll.ch> Date: Thu, 17 Nov 2016 12:23:12 +0200 Message-ID: <87wpg2z9pr.fsf@intel.com> MIME-Version: 1.0 Content-Type: text/plain Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 1776 Lines: 46 On Thu, 17 Nov 2016, Daniel Vetter wrote: > We don't just need better doc toolchains, we also need better docs for > our doc toolchain! > > v2: Make sure we don't have foo twice (Jani). Thanks, *now* LGTM. :) > > Cc: Daniel Vetter > Cc: Jani Nikula > Cc: Jonathan Corbet > Cc: linux-doc@vger.kernel.org > Signed-off-by: Daniel Vetter > --- > Documentation/kernel-documentation.rst | 7 ++++++- > 1 file changed, 6 insertions(+), 1 deletion(-) > > diff --git a/Documentation/kernel-documentation.rst b/Documentation/kernel-documentation.rst > index 10cc7ddb6235..0dd17069bc0b 100644 > --- a/Documentation/kernel-documentation.rst > +++ b/Documentation/kernel-documentation.rst > @@ -484,7 +484,10 @@ span multiple lines. The continuation lines may contain indentation. > In-line member documentation comments > ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > > -The structure members may also be documented in-line within the definition:: > +The structure members may also be documented in-line within the definition. > +There are two styles, single-line comments where both the opening ``/**`` and > +closing ``*/`` are on the same line, and multi-line comments where they are each > +on a line of their own, like all other kernel-doc comments:: > > /** > * struct foo - Brief description. > @@ -502,6 +505,8 @@ The structure members may also be documented in-line within the definition:: > * Here, the member description may contain several paragraphs. > */ > int baz; > + /** @foobar: Single line description. */ > + int foobar; > } > > Private members -- Jani Nikula, Intel Open Source Technology Center