Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753891AbcKQJnY (ORCPT ); Thu, 17 Nov 2016 04:43:24 -0500 Received: from mail-wm0-f66.google.com ([74.125.82.66]:32853 "EHLO mail-wm0-f66.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1750841AbcKQJnV (ORCPT ); Thu, 17 Nov 2016 04:43:21 -0500 From: Daniel Vetter To: LKML Cc: Daniel Vetter , Daniel Vetter , Jani Nikula , Jonathan Corbet , linux-doc@vger.kernel.org, Daniel Vetter Subject: [PATCH] doc: Document the new inline struct member kernel-doc style Date: Thu, 17 Nov 2016 10:43:12 +0100 Message-Id: <20161117094312.7825-1-daniel.vetter@ffwll.ch> X-Mailer: git-send-email 2.10.2 Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 1513 Lines: 39 We don't just need better doc toolchains, we also need better docs for our doc toolchain! 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 -- 2.10.2