Instead of loading all indexed doxygen symbols in one page, we use the defined groups to load the API documentation in the specific sections and reduce the trash coming from doxygen to just what we need. Change-Id: I030e3de33e8cc26871f95cd45a50af0cae1bb942 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
123 lines
1.6 KiB
ReStructuredText
123 lines
1.6 KiB
ReStructuredText
.. _api:
|
|
|
|
Auto-generated API Documentation
|
|
################################
|
|
|
|
Nanokernel
|
|
==========
|
|
|
|
Fibers
|
|
--------
|
|
|
|
.. doxygengroup:: nanokernel_fiber
|
|
:project: Zephyr
|
|
:content-only:
|
|
|
|
Semaphores
|
|
-----------
|
|
|
|
.. doxygengroup:: nanokernel_semaphore
|
|
:project: Zephyr
|
|
:content-only:
|
|
|
|
LIFOs
|
|
-----------
|
|
|
|
.. doxygengroup:: nanokernel_lifo
|
|
:project: Zephyr
|
|
:content-only:
|
|
|
|
FIFOs
|
|
-----------
|
|
|
|
.. doxygengroup:: nanokernel_fifo
|
|
:project: Zephyr
|
|
:content-only:
|
|
|
|
Stacks
|
|
-----------
|
|
|
|
.. doxygengroup:: nanokernel_stack
|
|
:project: Zephyr
|
|
:content-only:
|
|
|
|
Timers
|
|
-----------
|
|
|
|
.. doxygengroup:: nanokernel_timer
|
|
:project: Zephyr
|
|
:content-only:
|
|
|
|
Microkernel
|
|
===========
|
|
|
|
Events
|
|
-------
|
|
|
|
.. doxygengroup:: microkernel_event
|
|
:project: Zephyr
|
|
:content-only:
|
|
|
|
FIFOs
|
|
-----
|
|
|
|
.. doxygengroup:: microkernel_fifo
|
|
:project: Zephyr
|
|
:content-only:
|
|
|
|
Pipes
|
|
-----
|
|
|
|
.. doxygengroup:: microkernel_pipe
|
|
:project: Zephyr
|
|
:content-only:
|
|
|
|
Interrupt Services
|
|
------------------
|
|
|
|
.. doxygengroup:: microkernel_irq
|
|
:project: Zephyr
|
|
:content-only:
|
|
|
|
Mailboxes
|
|
------------------
|
|
|
|
.. doxygengroup:: microkernel_mailbox
|
|
:project: Zephyr
|
|
:content-only:
|
|
|
|
Memory Maps
|
|
------------
|
|
|
|
.. doxygengroup:: microkernel_memorymap
|
|
:project: Zephyr
|
|
:content-only:
|
|
|
|
Mutexes
|
|
---------
|
|
|
|
.. doxygengroup:: microkernel_mutex
|
|
:project: Zephyr
|
|
:content-only:
|
|
|
|
Semaphores
|
|
-----------
|
|
|
|
.. doxygengroup:: microkernel_semaphore
|
|
:project: Zephyr
|
|
:content-only:
|
|
|
|
Timers
|
|
-----------
|
|
|
|
.. doxygengroup:: microkernel_timer
|
|
:project: Zephyr
|
|
:content-only:
|
|
|
|
Tasks
|
|
-----------
|
|
|
|
.. doxygengroup:: microkernel_task
|
|
:project: Zephyr
|
|
:content-only:
|