Re: [PATCH] doc: Document the new inline struct member kernel-doc style

From	Jani Nikula <jani.nikula@intel.com>
Newsgroups	linux.kernel
Subject	Re: [PATCH] doc: Document the new inline struct member kernel-doc style
Date	2016-11-17 11:30 +0100
Message-ID	<sEs77-7Sn-1@gated-at.bofh.it> (permalink)
References	<sEruq-7iB-17@gated-at.bofh.it> <sEs77-7Sn-3@gated-at.bofh.it>
Organization	Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo

Show all headers | View raw

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

Thread

[PATCH] doc: Document the new inline struct member kernel-doc style Daniel Vetter <daniel.vetter@ffwll.ch> - 2016-11-17 10:50 +0100
  Re: [PATCH] doc: Document the new inline struct member kernel-doc style Jani Nikula <jani.nikula@intel.com> - 2016-11-17 11:00 +0100
    Re: [PATCH] doc: Document the new inline struct member kernel-doc style Jani Nikula <jani.nikula@intel.com> - 2016-11-17 11:10 +0100
  [PATCH] doc: Document the new inline struct member kernel-doc style Daniel Vetter <daniel.vetter@ffwll.ch> - 2016-11-17 11:30 +0100
    Re: [PATCH] doc: Document the new inline struct member kernel-doc style Jani Nikula <jani.nikula@intel.com> - 2016-11-17 11:30 +0100
    Re: [PATCH] doc: Document the new inline struct member kernel-doc  style Jonathan Corbet <corbet@lwn.net> - 2016-11-19 18:40 +0100

csiph-web