OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/doc/reference/api.rst

130 lines
1.7 KiB
ReStructuredText
Raw Normal View History

Doc: Create the Reference Guides part. Placeholders were created for the missing content. The automatically generated API docs were separated from the Doxygen collaboration guide. The Kbuild User's Guide was moved unchanged. Change-Id: I07dfed61bfbb3cad60372c57dc3cbdf627c872f0 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2015-08-08 06:24:03 +08:00
.. _api:
ADD in-code documentation integration files. Includes an explanation of how the in-code documentation is integrated using Doxygen / Breathe and the raw generated output from the code. These files are needed to understand how the in-code comments flow into the documentation and to be able to display and link to those comments from the documentation. Change-Id: I275f8c32cfe889da43b4db5b8037e52876ae3c68 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-05-16 00:39:18 +08:00
doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-22 22:43:36 +08:00
API Documentation
#################
ADD in-code documentation integration files. Includes an explanation of how the in-code documentation is integrated using Doxygen / Breathe and the raw generated output from the code. These files are needed to understand how the in-code comments flow into the documentation and to be able to display and link to those comments from the documentation. Change-Id: I275f8c32cfe889da43b4db5b8037e52876ae3c68 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-05-16 00:39:18 +08:00
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
Nanokernel
doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-22 22:43:36 +08:00
**********
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
Fibers
doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-22 22:43:36 +08:00
======
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
.. doxygengroup:: nanokernel_fiber
:project: Zephyr
:content-only:
Semaphores
doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-22 22:43:36 +08:00
==========
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
.. doxygengroup:: nanokernel_semaphore
:project: Zephyr
:content-only:
LIFOs
doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-22 22:43:36 +08:00
=====
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
.. doxygengroup:: nanokernel_lifo
:project: Zephyr
:content-only:
FIFOs
doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-22 22:43:36 +08:00
=====
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
.. doxygengroup:: nanokernel_fifo
:project: Zephyr
:content-only:
Stacks
doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-22 22:43:36 +08:00
======
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
.. doxygengroup:: nanokernel_stack
:project: Zephyr
:content-only:
Timers
doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-22 22:43:36 +08:00
======
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
.. doxygengroup:: nanokernel_timer
:project: Zephyr
:content-only:
Add group definition to event logger. Add the tags required by doxygen for defining the group of the kernel event logger. Change-Id: I96ec6b6604da5a541ce8041e6fa3c324a03ff698 Signed-off-by: Yonattan Louise <yonattan.a.louise.mendoza@intel.com>
2015-10-17 06:09:35 +08:00
Kernel Event Logger
-------------------
.. doxygengroup:: nanokernel_event_logger
:project: Zephyr
:content-only:
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
Microkernel
doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-22 22:43:36 +08:00
***********
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
Events
doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-22 22:43:36 +08:00
======
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
.. doxygengroup:: microkernel_event
:project: Zephyr
:content-only:
FIFOs
doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-22 22:43:36 +08:00
=====
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
.. doxygengroup:: microkernel_fifo
:project: Zephyr
:content-only:
Pipes
doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-22 22:43:36 +08:00
=====
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
.. doxygengroup:: microkernel_pipe
:project: Zephyr
:content-only:
Interrupt Services
doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-22 22:43:36 +08:00
==================
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
.. doxygengroup:: microkernel_irq
:project: Zephyr
:content-only:
Mailboxes
doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-22 22:43:36 +08:00
=========
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
.. doxygengroup:: microkernel_mailbox
:project: Zephyr
:content-only:
Memory Maps
doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-22 22:43:36 +08:00
===========
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
.. doxygengroup:: microkernel_memorymap
:project: Zephyr
:content-only:
Mutexes
doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-22 22:43:36 +08:00
=======
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
.. doxygengroup:: microkernel_mutex
:project: Zephyr
:content-only:
Semaphores
doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-22 22:43:36 +08:00
==========
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
.. doxygengroup:: microkernel_semaphore
:project: Zephyr
:content-only:
Timers
doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-22 22:43:36 +08:00
======
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
.. doxygengroup:: microkernel_timer
:project: Zephyr
:content-only:
Tasks
doc: Fix headings of the API documentation. Removes the Auto-generated text from the main heading. Changes the headings to the consistent hierarchy used elsewhere in the documentation. Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-22 22:43:36 +08:00
=====
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
.. doxygengroup:: microkernel_task
Tiny Mountain -> Zephyr renames Change-Id: I323c3c2bc06c8fc2b6200186dde6853c61b094a8 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-06-14 04:08:26 +08:00
:project: Zephyr
doc: remove doxygen index and add groups instead 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>
2015-09-14 23:54:34 +08:00
:content-only: