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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <8737iq1kwp.fsf@intel.com>
Date:   Thu, 17 Nov 2016 12:05:26 +0200
From:   Jani Nikula <jani.nikula@...el.com>
To:     Daniel Vetter <daniel.vetter@...ll.ch>,
        LKML <linux-kernel@...r.kernel.org>
Cc:     Daniel Vetter <daniel.vetter@...ll.ch>,
        Daniel Vetter <daniel@...ll.ch>,
        Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org,
        Daniel Vetter <daniel.vetter@...el.com>
Subject: Re: [PATCH] doc: Document the new inline struct member kernel-doc style

On Thu, 17 Nov 2016, Jani Nikula <jani.nikula@...el.com> wrote:
> On Thu, 17 Nov 2016, Daniel Vetter <daniel.vetter@...ll.ch> 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.

BR,
Jani.


>
> BR,
> Jani.
>
>
>> Cc: Daniel Vetter <daniel@...ll.ch>
>> Cc: Jani Nikula <jani.nikula@...el.com>
>> Cc: Jonathan Corbet <corbet@....net>
>> Cc: linux-doc@...r.kernel.org
>> Signed-off-by: Daniel Vetter <daniel.vetter@...el.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..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