diff options
| author | Sean Anderson <seanga2@gmail.com> | 2021-12-22 12:11:12 -0500 |
|---|---|---|
| committer | Sean Anderson <seanga2@gmail.com> | 2022-02-25 01:41:04 -0500 |
| commit | 9c88b13a9031e8c1d9f4c2422791f84cd6604242 (patch) | |
| tree | 61fe41d56d054b7608526479fb9736b423c37106 /doc/api | |
| parent | 14cacb019c2d2a97e8407fad08b164bc67def395 (diff) | |
| download | u-boot-9c88b13a9031e8c1d9f4c2422791f84cd6604242.tar.gz u-boot-9c88b13a9031e8c1d9f4c2422791f84cd6604242.tar.bz2 u-boot-9c88b13a9031e8c1d9f4c2422791f84cd6604242.zip | |
clk: Add client API to HTML docs
This converts the existing client (aka clk.h) documentation to kernel doc
format, and adds it to the HTML docs. I have tried to preserve existing
comments as much as possible, refraining from semantic changes.
Signed-off-by: Sean Anderson <seanga2@gmail.com>
Tested-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Reviewed-by: Simon Glass <sjg@chromium.org>
Link: https://lore.kernel.org/r/20211222171114.3091780-4-seanga2@gmail.com
[rebased onto u-boot/master and resolved conflicts]
Signed-off-by: Sean Anderson <seanga2@gmail.com>
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/clk.rst | 13 | ||||
| -rw-r--r-- | doc/api/index.rst | 1 |
2 files changed, 14 insertions, 0 deletions
diff --git a/doc/api/clk.rst b/doc/api/clk.rst new file mode 100644 index 0000000000..7eb3b5645a --- /dev/null +++ b/doc/api/clk.rst @@ -0,0 +1,13 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +Clock API +========= + +.. kernel-doc:: include/clk.h + :doc: Overview + +Client API +---------- + +.. kernel-doc:: include/clk.h + :internal: diff --git a/doc/api/index.rst b/doc/api/index.rst index 3f36174167..72fea981b7 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -6,6 +6,7 @@ U-Boot API documentation .. toctree:: :maxdepth: 2 + clk dfu dm efi |