u-boot.git/doc/api, branch v2022.04

clk: Add driver API to HTML docs

2022-02-25T06:41:04+00:00

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 
Tested-by: Heinrich Schuchardt 
Reviewed-by: Simon Glass 
Link: https://lore.kernel.org/r/20211222171114.3091780-5-seanga2@gmail.com

clk: Add client API to HTML docs

2022-02-25T06:41:04+00:00

This converts the existing client (aka clk.h) documentation to kernel doc
format, and adds it to the HTML docs. I have tried to preserve existing
comments as much as possible, refraining from semantic changes.

Signed-off-by: Sean Anderson 
Tested-by: Heinrich Schuchardt 
Reviewed-by: Simon Glass 
Link: https://lore.kernel.org/r/20211222171114.3091780-4-seanga2@gmail.com
[rebased onto u-boot/master and resolved conflicts]
Signed-off-by: Sean Anderson

doc: add include/dm/fdtaddr.h to the HTML documentation

2022-01-15T09:57:21+00:00

Correct Sphinx style comments in include/dm/fdtaddr.h
and add the devfdt API to the HTML documentation;
these functions are NOT compatible with live tree.

Signed-off-by: Patrick Delaunay 
Reviewed-by: Heinrich Schuchardt

doc: add include/dm/of*.h to the HTML documentation

2022-01-15T09:57:21+00:00

Correct Sphinx style comments in include/dm/ofnode.h
and add the device tree node API to the HTML documentation;
the ofnode functions are compatible with Live tree or with flat
device tree.

Signed-off-by: Patrick Delaunay 
Reviewed-by: Heinrich Schuchardt

doc: add include/dm/read.h to the HTML documentation

2022-01-15T09:57:21+00:00

Correct Sphinx style comments in include/dm/read.h
and add the device read from device tree API to the HTML
documentation.

Signed-off-by: Patrick Delaunay 
Reviewed-by: Heinrich Schuchardt

doc: add include/dm/devres.h to the HTML documentation

2022-01-15T09:57:21+00:00

Correct Sphinx style comments in include/dm/devres.h
and add the driver model device resource API, devres_*(),
to the HTML documentation.

Signed-off-by: Patrick Delaunay 
Reviewed-by-by: Heinrich Schuchardt

doc: add include/dm/device.h to the HTML documentation

2022-01-15T09:57:21+00:00

Correct Sphinx style comments in include/dm/device.h
and add the driver model device API to the HTML documentation.

Signed-off-by: Patrick Delaunay 
Reviewed-by: Heinrich Schuchardt

doc: add include/dm/platdata.h to the HTML documentation

2022-01-15T09:57:21+00:00

Correct Sphinx style comments in include/dm/platdata.h
and add the associated API to the HTML documentation.

Signed-off-by: Patrick Delaunay 
Reviewed-by: Heinrich Schuchardt

doc: add include/dm/lists.h to the HTML documentation

2022-01-15T09:57:21+00:00

Correct Sphinx style comments in include/dm/lists.h
and add the list API to the HTML documentation.

Signed-off-by: Patrick Delaunay 
Reviewed-by: Heinrich Schuchardt

doc: add include/dm/root.h to the HTML documentation

2022-01-15T09:57:21+00:00

Correct Sphinx style comments in include/dm/devres.h
and add the associated driver model API to the HTML documentation.

Signed-off-by: Patrick Delaunay 
Reviewed-by: Heinrich Schuchardt