diff options
| author | Sean Anderson <seanga2@gmail.com> | 2021-12-22 12:11:13 -0500 |
|---|---|---|
| committer | Sean Anderson <seanga2@gmail.com> | 2022-02-25 01:41:04 -0500 |
| commit | a0abea867a0d344d8e5290adf6380903b0f52e0f (patch) | |
| tree | 4be2bfe1e8f1e9b42255fcab60b6ca26a46e3241 /doc | |
| parent | 9c88b13a9031e8c1d9f4c2422791f84cd6604242 (diff) | |
| download | u-boot-a0abea867a0d344d8e5290adf6380903b0f52e0f.zip u-boot-a0abea867a0d344d8e5290adf6380903b0f52e0f.tar.gz u-boot-a0abea867a0d344d8e5290adf6380903b0f52e0f.tar.bz2 | |
clk: Add driver API to HTML docs
This converts the existing driver API docs (clk-uclass.h) to kernel doc
format and adds them to the HTML documentation. Because the kernel doc
sphinx converter does not handle functions in structs very well, the
individual methods are documented separately. This is primarily inspired by
the phylink documentation [1], which uses this trick extensively.
[1] https://www.kernel.org/doc/html/latest/networking/kapi.html#c.phylink_mac_ops
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-5-seanga2@gmail.com
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/clk.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/api/clk.rst b/doc/api/clk.rst index 7eb3b56..7c27066 100644 --- a/doc/api/clk.rst +++ b/doc/api/clk.rst @@ -11,3 +11,9 @@ Client API .. kernel-doc:: include/clk.h :internal: + +Driver API +---------- + +.. kernel-doc:: include/clk-uclass.h + :internal: |