lkml.org 
[lkml]   [2016]   [Nov]   [17]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
SubjectRe: [PATCH] doc: Document the new inline struct member kernel-doc style
Date
On Thu, 17 Nov 2016, Daniel Vetter <daniel.vetter@ffwll.ch> 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 <daniel@ffwll.ch>
> Cc: Jani Nikula <jani.nikula@intel.com>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> ---
> 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

\
 
 \ /
  Last update: 2016-11-17 11:23    [W:0.066 / U:1.284 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site