u-boot/doc/api/index.rst

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

U-Boot API documentation
========================

.. toctree::
   :maxdepth: 2

   dfu
   efi
   linker_lists
   pinctrl
   rng
   serial
   timer
   unicode
doc: Move existing rst files into api sub-directory Currently the Sphinx doc only contains API descriptions of several U-Boot subsystems. For future extension, group these existing docs into an API sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de> 2019-07-18 07:33:46 +00:00			`.. SPDX-License-Identifier: GPL-2.0+`

			`U-Boot API documentation`
			`========================`

			`.. toctree::`
			`:maxdepth: 2`

doc: dfu: add DFU to HTML documentation Add the device firmware update functions to the generated HTML documentation. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Acked-by: Lukasz Majewski <lukma@denx.de> 2020-05-23 10:01:08 +00:00			`dfu`
doc: Move existing rst files into api sub-directory Currently the Sphinx doc only contains API descriptions of several U-Boot subsystems. For future extension, group these existing docs into an API sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de> 2019-07-18 07:33:46 +00:00			`efi`
			`linker_lists`
pinctrl: Reformat documentation in dm/pinctrl.h This normalizes the documentation to conform to kernel-doc style [1]. It also moves the documentation for pinctrl_ops inline, and adds argument and return-value documentation. I have kept the usual function style for these comments. I could not find any existing examples of function documentation inside structs. [1] https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org> 2020-09-14 15:01:56 +00:00			`pinctrl`
doc: random number generation Add random number generation APIs to the HTML documentation. Fix style issues. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> 2020-06-13 10:29:52 +00:00			`rng`
doc: Move existing rst files into api sub-directory Currently the Sphinx doc only contains API descriptions of several U-Boot subsystems. For future extension, group these existing docs into an API sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de> 2019-07-18 07:33:46 +00:00			`serial`
doc: Document timer API This adds kerneldocs for <timer.h>. I don't know who should maintain doc/api/timer.rst, since the timer subsystem seems to be maintained by SoC maintainers. MAINTAINERS is left un-updated for the moment. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org> 2020-10-07 18:37:43 +00:00			`timer`
doc: add Unicode functions to API description Add include/charset.h to generated HTML documentation Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> 2020-05-09 07:00:59 +00:00			`unicode`