u-boot/doc/api/clk.rst

.. SPDX-License-Identifier: GPL-2.0+

Clock API
=========

.. kernel-doc:: include/clk.h
   :doc: Overview

Client API
----------

.. kernel-doc:: include/clk.h
   :internal:

Driver API
----------

.. kernel-doc:: include/clk-uclass.h
   :internal:
clk: Add client API to HTML docs 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 <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-4-seanga2@gmail.com [rebased onto u-boot/master and resolved conflicts] Signed-off-by: Sean Anderson <seanga2@gmail.com> 2021-12-22 17:11:12 +00:00			`.. SPDX-License-Identifier: GPL-2.0+`

			`Clock API`
			`=========`

			`.. kernel-doc:: include/clk.h`
			`:doc: Overview`

			`Client API`
			`----------`

			`.. kernel-doc:: include/clk.h`
			`:internal:`
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 2021-12-22 17:11:13 +00:00
			`Driver API`
			`----------`

			`.. kernel-doc:: include/clk-uclass.h`
			`:internal:`