a3edcaa816
Edit public API details for clarity, grammar, punctuation found on file event_logger.h Includes the event logger information in the ReST documentation. Modifies doxygen.config to include the event logger. Made consistent use of @retval to document return values. Used imperative verbs for all @brief descriptions. Change-Id: I88b8672a527138e2b4f7df4b4b0495a0d871cad3 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
24 lines
642 B
ReStructuredText
24 lines
642 B
ReStructuredText
.. _api:
|
|
|
|
API Documentation
|
|
#################
|
|
|
|
Welcome to the Zephyr Project's
|
|
:abbr:`API (Application Programing Interface)` documentation.
|
|
|
|
This section contains the API documentation automatically extracted from the
|
|
code. To ease navigation, we have split the APis in nanokernel APIs and
|
|
microkernel APIs. If you are looking for a specific API, enter it on the
|
|
search box. The search results display all sections containing information
|
|
about that API.
|
|
|
|
The use of the Zephyr APIs is the same for all platforms and boards.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
nanokernel_api.rst
|
|
microkernel_api.rst
|
|
io_interfaces.rst
|
|
event_logger.rst
|