We don't just need better doc toolchains, we also need better docs for
our doc toolchain!
Cc: Daniel Vetter <[email protected]>
Cc: Jani Nikula <[email protected]>
Cc: Jonathan Corbet <[email protected]>
Cc: [email protected]
Signed-off-by: Daniel Vetter <[email protected]>
---
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
--
2.10.2
On Thu, 17 Nov 2016, Daniel Vetter <[email protected]> wrote:
> We don't just need better doc toolchains, we also need better docs for
> our doc toolchain!
Mea culpa. Thanks, LGTM.
BR,
Jani.
> Cc: Daniel Vetter <[email protected]>
> Cc: Jani Nikula <[email protected]>
> Cc: Jonathan Corbet <[email protected]>
> Cc: [email protected]
> Signed-off-by: Daniel Vetter <[email protected]>
> ---
> 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
On Thu, 17 Nov 2016, Jani Nikula <[email protected]> wrote:
> On Thu, 17 Nov 2016, Daniel Vetter <[email protected]> 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 <[email protected]>
>> Cc: Jani Nikula <[email protected]>
>> Cc: Jonathan Corbet <[email protected]>
>> Cc: [email protected]
>> Signed-off-by: Daniel Vetter <[email protected]>
>> ---
>> 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
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).
Cc: Daniel Vetter <[email protected]>
Cc: Jani Nikula <[email protected]>
Cc: Jonathan Corbet <[email protected]>
Cc: [email protected]
Signed-off-by: Daniel Vetter <[email protected]>
---
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
--
2.10.2
On Thu, 17 Nov 2016, Daniel Vetter <[email protected]> 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 <[email protected]>
> Cc: Jani Nikula <[email protected]>
> Cc: Jonathan Corbet <[email protected]>
> Cc: [email protected]
> Signed-off-by: Daniel Vetter <[email protected]>
> ---
> 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
On Thu, 17 Nov 2016 11:19:43 +0100
Daniel Vetter <[email protected]> wrote:
> We don't just need better doc toolchains, we also need better docs for
> our doc toolchain!
Indeed. Applied, thanks.
jon