diff options
| author | Sean Anderson <seanga2@gmail.com> | 2020-09-14 18:01:56 +0300 |
|---|---|---|
| committer | Tom Rini <trini@konsulko.com> | 2020-10-08 18:42:36 +0300 |
| commit | 5eee93e5b1ae9b2b31db99f774e0f635ad276068 (patch) | |
| tree | 90251c6714f937da291946260fc8d316def8741b /doc | |
| parent | 9c08fbfc951fa90953b75462e5dff533c0031a4d (diff) | |
| download | u-boot-5eee93e5b1ae9b2b31db99f774e0f635ad276068.tar.xz | |
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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/index.rst | 1 | ||||
| -rw-r--r-- | doc/api/pinctrl.rst | 7 |
2 files changed, 8 insertions, 0 deletions
diff --git a/doc/api/index.rst b/doc/api/index.rst index b7eb5725f2..1c261bcb73 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -9,6 +9,7 @@ U-Boot API documentation dfu efi linker_lists + pinctrl rng serial unicode diff --git a/doc/api/pinctrl.rst b/doc/api/pinctrl.rst new file mode 100644 index 0000000000..043bd57efa --- /dev/null +++ b/doc/api/pinctrl.rst @@ -0,0 +1,7 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +Pinctrl and Pinmux +================== + +.. kernel-doc:: include/dm/pinctrl.h + :internal: |