docs: kernel-doc.rst: improve function documentation section
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Mon, 18 Dec 2017 12:30:04 +0000 (10:30 -0200)
committerJonathan Corbet <corbet@lwn.net>
Thu, 21 Dec 2017 20:41:46 +0000 (13:41 -0700)
commitfc275bf3b99d2c78e1c132d2199be1cb6a701905
tree0e88b84d22db6fc158668a46466c9937b029313c
parent01f2c18073e284397f45c94b26e65fd1b66776e4
docs: kernel-doc.rst: improve function documentation section

Move its contents to happen earlier and improve the description
of return values, adding a subsection to it. Most of the contents
there came from kernel-doc-nano-HOWTO.txt.

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