[PATCH v2 4/5] clk: Add driver API to HTML docs

Simon Glass sjg at chromium.org
Tue Dec 28 09:33:58 CET 2021


On Wed, 22 Dec 2021 at 10:11, Sean Anderson <seanga2 at gmail.com> wrote:
>
> 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 at gmail.com>
> Tested-by: Heinrich Schuchardt <xypron.glpk at gmx.de>
> ---
>
> Changes in v2:
> - Clean up the argument list and descriptions
>
>  doc/api/clk.rst      |   6 ++
>  include/clk-uclass.h | 187 +++++++++++++++++++++++++------------------
>  2 files changed, 115 insertions(+), 78 deletions(-)

Reviewed-by: Simon Glass <sjg at chromium.org>

Oh yuk...


More information about the U-Boot mailing list