Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S935507AbcKQKFd (ORCPT ); Thu, 17 Nov 2016 05:05:33 -0500 Received: from mga04.intel.com ([192.55.52.120]:47511 "EHLO mga04.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753793AbcKQKFa (ORCPT ); Thu, 17 Nov 2016 05:05:30 -0500 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.31,653,1473145200"; d="scan'208";a="787521619" 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: <8760nm1lay.fsf@intel.com> Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo References: <20161117094312.7825-1-daniel.vetter@ffwll.ch> <8760nm1lay.fsf@intel.com> Date: Thu, 17 Nov 2016 12:05:26 +0200 Message-ID: <8737iq1kwp.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: 1942 Lines: 56 On Thu, 17 Nov 2016, Jani Nikula wrote: > 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! > > Mea culpa. Thanks, LGTM. Oh, the example struct now has too "foo" fields, documented twice. That's not good. BR, Jani. > > BR, > Jani. > > >> 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..a5bd12d8bd4e 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; >> + /** @foo: Single line description. */ >> + int foo; >> } >> >> Private members -- Jani Nikula, Intel Open Source Technology Center