|
@@ -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
|