Re: [PATCH] doc: Document the new inline struct member kernel-doc style
From: Jani Nikula
Date: Thu Nov 17 2016 - 05:23:22 EST
On Thu, 17 Nov 2016, Daniel Vetter <daniel.vetter@xxxxxxxx> 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@xxxxxxxx>
> Cc: Jani Nikula <jani.nikula@xxxxxxxxx>
> Cc: Jonathan Corbet <corbet@xxxxxxx>
> Cc: linux-doc@xxxxxxxxxxxxxxx
> Signed-off-by: Daniel Vetter <daniel.vetter@xxxxxxxxx>
> 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