leandrof/u-boot
1
0
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

clk: Add driver API to HTML docs

Browse Source 
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
This commit is contained in:
Sean Anderson
2021-12-22 12:11:13 -05:00
parent 9c88b13a90
commit a0abea867a
2 changed files with 115 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/api/clk.rst
View File

@@ -11,3 +11,9 @@ Client API
.. kernel-doc:: include/clk.h
:internal:
Driver API
----------
.. kernel-doc:: include/clk-uclass.h
:internal: