pinctrl: Reformat documentation in dm/pinctrl.h
authorSean Anderson <seanga2@gmail.com>
Mon, 14 Sep 2020 15:01:56 +0000 (11:01 -0400)
committerTom Rini <trini@konsulko.com>
Thu, 8 Oct 2020 15:42:36 +0000 (11:42 -0400)
commit5eee93e5b1ae9b2b31db99f774e0f635ad276068
tree90251c6714f937da291946260fc8d316def8741b
parent9c08fbfc951fa90953b75462e5dff533c0031a4d
pinctrl: Reformat documentation in dm/pinctrl.h

This normalizes the documentation to conform to kernel-doc style [1]. It
also moves the documentation for pinctrl_ops inline, and adds argument and
return-value documentation. I have kept the usual function style for these
comments. I could not find any existing examples of function documentation
inside structs.

[1] https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html

Signed-off-by: Sean Anderson <seanga2@gmail.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
doc/api/index.rst
doc/api/pinctrl.rst [new file with mode: 0644]
include/dm/pinctrl.h