diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2018-02-16 11:48:15 -0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2018-02-18 16:54:34 -0700 |
| commit | 3651d452fd19e6d868cf9c639ecd2798a35a014a (patch) | |
| tree | abd3e2a7d0746b3e059da719d788a60a566b297f /Documentation/doc-guide/kernel-doc.rst | |
| parent | bcd3cf0855c561d97146834c46f27aacc90252b4 (diff) | |
doc-guide: kernel-doc: fix example for nested_foobar struct
There's a missing */ at the end of Kernel docs example.
Even adding it, it will still produce 3 warnings:
example:33: warning: Function parameter or member 'bar' not described in 'nested_foobar'
example:33: warning: Function parameter or member 'bar.st1' not described in 'nested_foobar'
example:33: warning: Function parameter or member 'bar.st2' not described in 'nested_foobar'
So, make the example more complete and add the missing end
of comment there.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/doc-guide/kernel-doc.rst')
| -rw-r--r-- | Documentation/doc-guide/kernel-doc.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index 2fb7f2bfc245..9fce378dccb2 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -250,10 +250,14 @@ It is possible to document nested structs and unions, like:: * @memb2: second member of anonymous union/anonymous struct * @memb3: third member of anonymous union/anonymous struct * @memb4: fourth member of anonymous union/anonymous struct + * @bar: non-anonymous union + * @bar.st1: struct st1 inside @bar + * @bar.st2: struct st2 inside @bar * @bar.st1.memb1: first member of struct st1 on union bar * @bar.st1.memb2: second member of struct st1 on union bar * @bar.st2.memb1: first member of struct st2 on union bar * @bar.st2.memb2: second member of struct st2 on union bar + */ struct nested_foobar { /* Anonymous union/struct*/ union { |