]> git.baikalelectronics.ru Git - kernel.git/commit
doc-guide: kernel-doc: fix example for nested_foobar struct
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Fri, 16 Feb 2018 13:48:15 +0000 (11:48 -0200)
committerJonathan Corbet <corbet@lwn.net>
Sun, 18 Feb 2018 23:54:34 +0000 (16:54 -0700)
commita975c053c79b2b5c2c32780a896792359bc44032
treeabd3e2a7d0746b3e059da719d788a60a566b297f
parentf7192e6810d0bc6caa8d94faa33c655b7159f61f
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>
Documentation/doc-guide/kernel-doc.rst