zephyr/doc/reference/index.rst

.. _api_reference:

API Reference
#############

.. toctree::
   :maxdepth: 1

   overview.rst
   terminology.rst
   audio/index.rst
   misc/notify.rst
   bluetooth/index.rst
   kconfig/index.rst
   crypto/index.rst
   devicetree/index.rst
   drivers/index.rst
   display/index.rst
   file_system/index.rst
   kernel/index.rst
   logging/index.rst
   misc/index
   networking/index.rst
   peripherals/index.rst
   power_management/index.rst
   random/index.rst
   resource_management/index.rst
   shell/index.rst
   storage/index.rst
   usb/index.rst
   usermode/index.rst
   settings/index.rst
doc: introduce final structure Move guides and APIs into separate directories and cleanup naming introducing index files rather than named section files. Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2019-02-03 00:06:11 +08:00			`.. _api_reference:`

			`API Reference`
			`#############`

			`.. toctree::`
			`:maxdepth: 1`

doc: rename reference/stability to reference/overview This page has a lot more information about APIs than just stability, and I believe it's currently our only exhaustive list of APIs. Rename it to API Overview. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> 2020-03-21 02:10:02 +08:00			`overview.rst`
doc: reference: Move terminology to its own page Move the terminology section to its own page in preparation for additional sections to be addded later. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no> 2020-02-20 02:04:29 +08:00			`terminology.rst`
doc: reference: Add pages for audio Add reference pages for the following APIs: - Audio Codec - DMIC Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no> 2020-03-17 20:03:51 +08:00			`audio/index.rst`
sys: add generic asynchronous notification infrastructure k_poll() for a signal is often desired for notification of completion of asynchronous operations, but there are APIs where it may be necessary to invoke "asynchronous" operations from contexts where sleep is disallowed, or before the kernel has been initialized. Extract the general notification solution from the on-off service into a utility that can be used for other APIs. Also move documentation out to a resource management section. Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no> 2020-02-19 20:01:07 +08:00			`misc/notify.rst`
doc: introduce final structure Move guides and APIs into separate directories and cleanup naming introducing index files rather than named section files. Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2019-02-03 00:06:11 +08:00			`bluetooth/index.rst`
			`kconfig/index.rst`
docs: crypto: crypto API documentation Fix crypto API doxygen syntax and integrate into documentation as RST. Fixes #21820 Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2020-03-13 02:14:53 +08:00			`crypto/index.rst`
doc: dts: revisit documentation This is joint work with Kumar Gala (see signed-off-by). Document the changes to the generated node macros in macros.bnf, moving the old file to legacy-macros.bnf and putting it in its own section. The actual generated macros are now a low-level detail, so rewrite the foregoing sections as examples in terms of the new <devicetree.h> APIs. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> Signed-off-by: Kumar Gala <kumar.gala@linaro.org> 2020-03-11 09:16:25 +08:00			`devicetree/index.rst`
doc: introduce final structure Move guides and APIs into separate directories and cleanup naming introducing index files rather than named section files. Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2019-02-03 00:06:11 +08:00			`drivers/index.rst`
			`display/index.rst`
			`file_system/index.rst`
			`kernel/index.rst`
			`logging/index.rst`
			`misc/index`
			`networking/index.rst`
			`peripherals/index.rst`
			`power_management/index.rst`
subsys/random: Add cryptographically secure and bulk fill functions 1) Add cryptographically secure random functions to provide FIPS 140-2 compliant random functions. 2) Add name to random function choice selectors to ease selection in SOC .defconfig files 3) Add bulk fill random functions. Signed-off-by: David Leach <david.leach@nxp.com> 2019-07-24 03:16:24 +08:00			`random/index.rst`
sys: add generic asynchronous notification infrastructure k_poll() for a signal is often desired for notification of completion of asynchronous operations, but there are APIs where it may be necessary to invoke "asynchronous" operations from contexts where sleep is disallowed, or before the kernel has been initialized. Extract the general notification solution from the on-off service into a utility that can be used for other APIs. Also move documentation out to a resource management section. Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no> 2020-02-19 20:01:07 +08:00			`resource_management/index.rst`
doc: introduce final structure Move guides and APIs into separate directories and cleanup naming introducing index files rather than named section files. Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2019-02-03 00:06:11 +08:00			`shell/index.rst`
			`storage/index.rst`
			`usb/index.rst`
doc: move usermode under references Move usermode documentation to be under api reference and not under kernel. Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2019-03-26 03:50:40 +08:00			`usermode/index.rst`
doc: reference: Clean up and restructure a bit Name all subsystem reference consistently with an '_api' postfix and clean up naming and folder structure in some cases. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no> 2020-03-14 02:02:31 +08:00			`settings/index.rst`