summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorDaniel Vetter <daniel.vetter@ffwll.ch>2016-11-17 11:19:43 +0100
committerJonathan Corbet <corbet@lwn.net>2016-11-19 18:17:12 +0100
commit38f985e3c9bb33d5422103807eb0a54f4ad39a0d (patch)
treefbd38da70dd1122c1bea2d10f9a40316e82ab510 /Documentation
parentMerge remote-tracking branch 'sound/topic/restize-docs' into sound (diff)
downloadlinux-38f985e3c9bb33d5422103807eb0a54f4ad39a0d.tar.xz
linux-38f985e3c9bb33d5422103807eb0a54f4ad39a0d.zip
doc: Document the new inline struct member kernel-doc style
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 <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> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/kernel-documentation.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/Documentation/kernel-documentation.rst b/Documentation/kernel-documentation.rst
index c66ab937c2ca..3fcf0ad6e5f0 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