Re: [PATCH] doc: Document the new inline struct member kernel-doc style
From: Jani Nikula
Date: Thu Nov 17 2016 - 05:05:59 EST
On Thu, 17 Nov 2016, Jani Nikula <jani.nikula@xxxxxxxxx> wrote:
> 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!
> Mea culpa. Thanks, LGTM.
Oh, the example struct now has too "foo" fields, documented
twice. That's not good.
>> 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..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