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>
This commit is contained in:
Sean Anderson
2020-09-14 11:01:56 -04:00
committed by Tom Rini
parent 9c08fbfc95
commit 5eee93e5b1
3 changed files with 347 additions and 162 deletions

View File

@@ -9,6 +9,7 @@ U-Boot API documentation
dfu
efi
linker_lists
pinctrl
rng
serial
unicode

7
doc/api/pinctrl.rst Normal file
View File

@@ -0,0 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0+
Pinctrl and Pinmux
==================
.. kernel-doc:: include/dm/pinctrl.h
:internal: