clk: Add driver API to HTML docs
authorSean Anderson <seanga2@gmail.com>
Wed, 22 Dec 2021 17:11:13 +0000 (12:11 -0500)
committerSean Anderson <seanga2@gmail.com>
Fri, 25 Feb 2022 06:41:04 +0000 (01:41 -0500)
commita0abea867a0d344d8e5290adf6380903b0f52e0f
tree4be2bfe1e8f1e9b42255fcab60b6ca26a46e3241
parent9c88b13a9031e8c1d9f4c2422791f84cd6604242
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
doc/api/clk.rst
include/clk-uclass.h