docs: kernel-doc.rst: better describe kernel-doc arguments
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Mon, 18 Dec 2017 12:30:02 +0000 (10:30 -0200)
committerJonathan Corbet <corbet@lwn.net>
Thu, 21 Dec 2017 20:41:45 +0000 (13:41 -0700)
commit63ac85174a5455bf0ed14fa37515015de33d0fe9
treecaeaf3c3a78f5cf51d29b2de2072949831684530
parent012e93cbdb28329e615b937bb2bb7d61aee5d0d1
docs: kernel-doc.rst: better describe kernel-doc arguments

Add a new section to describe kernel-doc arguments,
adding examples about how identation should happen, as failing
to do that causes Sphinx to do the wrong thing.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/doc-guide/kernel-doc.rst