iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc-guide: kernel-doc: add examples about nested union/structs

Browse Source 
It helps to give some examples about how to use in-line
comments also when nested union/structs are present. So add it.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2018-02-16 11:48:19 -02:00 committed by Jonathan Corbet
parent fe7bc493d9
commit dbcce2bfb7
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Documentation/doc-guide/kernel-doc.rst
View File

@ -286,8 +286,17 @@ on a line of their own, like all other kernel-doc comments::
* Here, the member description may contain several paragraphs. * Here, the member description may contain several paragraphs.
*/ */
int baz; int baz;
/** @foobar: Single line description. */ union {
int foobar; /** @foobar: Single line description. */
int foobar;
};
/** @bar2: Description for struct @bar2 inside @foo */
struct {
/**
* @bar2.barbar: Description for @barbar inside @foo.bar2
*/
int barbar;
} bar2;
}; };
Typedef documentation Typedef documentation