u-boot/doc/api
Sean Anderson a0abea867a 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
2022-02-25 01:41:04 -05:00
..
clk.rst clk: Add driver API to HTML docs 2022-02-25 01:41:04 -05:00
dfu.rst doc: dfu: add DFU to HTML documentation 2020-05-25 11:54:53 -04:00
dm.rst doc: add include/dm/fdtaddr.h to the HTML documentation 2022-01-15 10:57:21 +01:00
efi.rst efi_loader: prepare for read only OP-TEE variables 2020-07-11 23:14:16 +02:00
getopt.rst lib: Add getopt 2020-10-30 10:56:11 -04:00
index.rst clk: Add client API to HTML docs 2022-02-25 01:41:04 -05:00
linker_lists.rst linker_lists: Fix alignment issue 2020-12-18 20:32:21 -07:00
lmb.rst doc: add include/lmb.h to the HTML documentation 2021-11-20 10:53:00 +01:00
logging.rst doc: fix doc/develop/logging.rst 2021-01-27 12:52:57 +01:00
pinctrl.rst pinctrl: Reformat documentation in dm/pinctrl.h 2020-10-08 11:42:36 -04:00
rng.rst doc: random number generation 2020-06-14 21:07:20 +02:00
sandbox.rst doc: add sandbox API 2020-11-05 09:11:31 -07:00
serial.rst doc: Move existing rst files into api sub-directory 2019-07-24 10:07:24 -04:00
sysreset.rst doc: add system reset to API documentation 2021-10-21 03:46:03 +02:00
timer.rst doc: Document timer API 2020-10-22 09:54:53 -04:00
unicode.rst doc: add Unicode functions to API description 2020-05-09 09:30:28 +02:00