From 9c88b13a9031e8c1d9f4c2422791f84cd6604242 Mon Sep 17 00:00:00 2001 From: Sean Anderson Date: Wed, 22 Dec 2021 12:11:12 -0500 Subject: 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 Tested-by: Heinrich Schuchardt Reviewed-by: Simon Glass 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 --- doc/api/clk.rst | 13 +++++++++++++ doc/api/index.rst | 1 + 2 files changed, 14 insertions(+) create mode 100644 doc/api/clk.rst (limited to 'doc') diff --git a/doc/api/clk.rst b/doc/api/clk.rst new file mode 100644 index 00000000000..7eb3b5645ad --- /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 3f361741677..72fea981b72 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 -- cgit v1.2.3