mirror of
https://source.denx.de/u-boot/u-boot.git
synced 2025-10-31 16:31:25 +01:00
a0abea867a
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
20 lines
250 B
ReStructuredText
20 lines
250 B
ReStructuredText
.. 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:
|