michaelh/zephyr
1
0
Fork 0
Code Releases Activity
zephyr/doc/reference/index.rst

41 lines
789 B
ReStructuredText
Raw Normal View History

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-02 11:06:11 -05: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-20 11:10:02 -07: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-19 19:04:29 +01: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 13:03:51 +01: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 06:01:07 -06: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-02 11:06:11 -05: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-12 14:14:53 -04: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-10 18:16:25 -07: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-02 11:06:11 -05:00
drivers/index.rst
display/index.rst
edac: doc: Include EDAC API to Zephyr API Reference Include EDAC API to generated Zephyr API Reference. Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
2021-01-14 13:04:24 +02:00
edac/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-02 11:06:11 -05:00
file_system/index.rst
lib: add cbprintf capability This commit adds a C99 stdio value formatter capability where generated text is emitted through a callback. This allows generation of arbitrarily long output without a buffer, functionality that is core to printk, logging, and other system and application needs. The formatter supports most C99 specifications, excluding: * %Lf long double conversion * wide character output Kconfig options allow disabling features like floating-point conversion if they are not necessary. By default most conversions are enabled. The original z_vprintk() implementation is adapted to meet the interface requirements of cbvprintf, and made available as an opt-in feature for space-constrained applications that do not need full formatting support. Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2020-11-08 06:24:22 -06:00
misc/formatted_output.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-02 11:06:11 -05:00
kernel/index.rst
logging/index.rst
misc/index
doc: Add docs on data structures Add some documentation and diagrams for OS library data structures: dlist/slist, rbtree and ring buffer. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2020-04-27 11:26:25 -07:00
misc/data_structures.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-02 11:06:11 -05:00
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-23 14:16:24 -05: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 06:01:07 -06: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-02 11:06:11 -05:00
shell/index.rst
storage/index.rst
task_wdt: add task-level watchdog subsystem This new subsystem can be used to supervise individual threads. It is based on a regularly updated kernel timer, whose ISR is never actually called in regular system operation. An existing hardware watchdog can be used as an optional fallback if the task watchdog itself gets stuck. Signed-off-by: Martin Jäger <martin@libre.solar>
2020-11-18 16:23:17 +01:00
task_wdt/index.rst
doc: add a section for timeutil APIs Describe the role of these APIs, key concepts that they depend on, and expose the low-level API. Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2020-10-07 11:59:48 -05:00
misc/timeutil.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-02 11:06:11 -05:00
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-25 15:50:40 -04:00
usermode/index.rst
api: promote sys/util.h to experimental This file contains definitions for macros which are integral to significant Zephyr use cases, such as CONTAINER_OF() and various macros used by devicetree.h internally. As such, in practice we expect at least advanced (if not intermediate) users to understand it, so the fact that it's not formally documented as an API with a stability level is a problem. Fix that by giving the docstrings a once-over and adding new ones where they are missing. Move all the remaining non-API macros to util_internal.h. Add a Sphinx API page for this header, and include it in the API overview at "experimental" stability level. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-06-11 16:47:30 -07:00
util/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-13 19:02:31 +01:00
settings/index.rst
doc: add documentation for timing functions This adds basic documentation on timing functions, and how to use them. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2020-11-11 12:57:57 -08:00
timing_functions/index.rst
doc: Adding ivshmem general and API documentation A quick summary on what is ivshmem and its Zephyr driver API. Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
2020-12-09 12:46:38 +01:00
virtualization/index.rst
Copy permalink