diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2018-02-16 14:48:16 +0100 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2018-02-19 00:54:44 +0100 |
| commit | 6e96788bd8d90bb66f65264e01be7ec7abd36215 (patch) | |
| tree | b99b4f10fe7cc13016a1f3559a6b4b54d7ef1e08 /Documentation/doc-guide | |
| parent | doc-guide: kernel-doc: fix example for nested_foobar struct (diff) | |
| download | linux-6e96788bd8d90bb66f65264e01be7ec7abd36215.tar.xz linux-6e96788bd8d90bb66f65264e01be7ec7abd36215.zip | |
doc-guide: kernel-doc: fix example for inlined comments
Without ending with a ";", kernel-doc doesn't recognize it
as an struct, and it fails to parse the example.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/doc-guide')
| -rw-r--r-- | Documentation/doc-guide/kernel-doc.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index 9fce378dccb2..3c00ce0c84e5 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -237,7 +237,7 @@ on a line of their own, like all other kernel-doc comments:: int baz; /** @foobar: Single line description. */ int foobar; - } + }; Nested structs/unions ~~~~~~~~~~~~~~~~~~~~~ |