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

87 lines
1.1 KiB
ReStructuredText
Raw Normal View History

doc: API documentation refactoring. Restructured the API documentation and moved it from the Reference section to the Developer guides section. Added a note about the search function to help users find the API they are looking for faster. Splitted the API docs into two files one for nanokernel and another for the microkernel APIs. Added table of contents for each of the API sections with a back link on the headings to take the users back to the top of the page. Making navigation easier and more user friendly. Change-Id: I80f415a60ea9c7df22276b464013e906e1efa511 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-02 01:28:50 +08:00
.. microkernel_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: API documentation refactoring. Restructured the API documentation and moved it from the Reference section to the Developer guides section. Added a note about the search function to help users find the API they are looking for faster. Splitted the API docs into two files one for nanokernel and another for the microkernel APIs. Added table of contents for each of the API sections with a back link on the headings to take the users back to the top of the page. Making navigation easier and more user friendly. Change-Id: I80f415a60ea9c7df22276b464013e906e1efa511 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-02 01:28:50 +08:00
Microkernel APIs
################
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: API documentation refactoring. Restructured the API documentation and moved it from the Reference section to the Developer guides section. Added a note about the search function to help users find the API they are looking for faster. Splitted the API docs into two files one for nanokernel and another for the microkernel APIs. Added table of contents for each of the API sections with a back link on the headings to take the users back to the top of the page. Making navigation easier and more user friendly. Change-Id: I80f415a60ea9c7df22276b464013e906e1efa511 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-02 01:28:50 +08:00
.. contents::
:depth: 1
:local:
:backlinks: top
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: API documentation refactoring. Restructured the API documentation and moved it from the Reference section to the Developer guides section. Added a note about the search function to help users find the API they are looking for faster. Splitted the API docs into two files one for nanokernel and another for the microkernel APIs. Added table of contents for each of the API sections with a back link on the headings to take the users back to the top of the page. Making navigation easier and more user friendly. Change-Id: I80f415a60ea9c7df22276b464013e906e1efa511 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-02 01:28:50 +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: API documentation refactoring. Restructured the API documentation and moved it from the Reference section to the Developer guides section. Added a note about the search function to help users find the API they are looking for faster. Splitted the API docs into two files one for nanokernel and another for the microkernel APIs. Added table of contents for each of the API sections with a back link on the headings to take the users back to the top of the page. Making navigation easier and more user friendly. Change-Id: I80f415a60ea9c7df22276b464013e906e1efa511 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-02 01:28:50 +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: API documentation refactoring. Restructured the API documentation and moved it from the Reference section to the Developer guides section. Added a note about the search function to help users find the API they are looking for faster. Splitted the API docs into two files one for nanokernel and another for the microkernel APIs. Added table of contents for each of the API sections with a back link on the headings to take the users back to the top of the page. Making navigation easier and more user friendly. Change-Id: I80f415a60ea9c7df22276b464013e906e1efa511 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-02 01:28:50 +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: API documentation refactoring. Restructured the API documentation and moved it from the Reference section to the Developer guides section. Added a note about the search function to help users find the API they are looking for faster. Splitted the API docs into two files one for nanokernel and another for the microkernel APIs. Added table of contents for each of the API sections with a back link on the headings to take the users back to the top of the page. Making navigation easier and more user friendly. Change-Id: I80f415a60ea9c7df22276b464013e906e1efa511 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-02 01:28:50 +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: API documentation refactoring. Restructured the API documentation and moved it from the Reference section to the Developer guides section. Added a note about the search function to help users find the API they are looking for faster. Splitted the API docs into two files one for nanokernel and another for the microkernel APIs. Added table of contents for each of the API sections with a back link on the headings to take the users back to the top of the page. Making navigation easier and more user friendly. Change-Id: I80f415a60ea9c7df22276b464013e906e1efa511 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-02 01:28:50 +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: API documentation refactoring. Restructured the API documentation and moved it from the Reference section to the Developer guides section. Added a note about the search function to help users find the API they are looking for faster. Splitted the API docs into two files one for nanokernel and another for the microkernel APIs. Added table of contents for each of the API sections with a back link on the headings to take the users back to the top of the page. Making navigation easier and more user friendly. Change-Id: I80f415a60ea9c7df22276b464013e906e1efa511 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-02 01:28:50 +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:
docs: fixed API linking Change-Id: If9daa0e11c967ee19684dd9d08438f749abf9d5e
2016-02-15 03:24:37 +08:00
Memory Pools
************
.. doxygengroup:: microkernel_memorypool
: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
Mutexes
doc: API documentation refactoring. Restructured the API documentation and moved it from the Reference section to the Developer guides section. Added a note about the search function to help users find the API they are looking for faster. Splitted the API docs into two files one for nanokernel and another for the microkernel APIs. Added table of contents for each of the API sections with a back link on the headings to take the users back to the top of the page. Making navigation easier and more user friendly. Change-Id: I80f415a60ea9c7df22276b464013e906e1efa511 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-02 01:28:50 +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: API documentation refactoring. Restructured the API documentation and moved it from the Reference section to the Developer guides section. Added a note about the search function to help users find the API they are looking for faster. Splitted the API docs into two files one for nanokernel and another for the microkernel APIs. Added table of contents for each of the API sections with a back link on the headings to take the users back to the top of the page. Making navigation easier and more user friendly. Change-Id: I80f415a60ea9c7df22276b464013e906e1efa511 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-02 01:28:50 +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: API documentation refactoring. Restructured the API documentation and moved it from the Reference section to the Developer guides section. Added a note about the search function to help users find the API they are looking for faster. Splitted the API docs into two files one for nanokernel and another for the microkernel APIs. Added table of contents for each of the API sections with a back link on the headings to take the users back to the top of the page. Making navigation easier and more user friendly. Change-Id: I80f415a60ea9c7df22276b464013e906e1efa511 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-02 01:28:50 +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: API documentation refactoring. Restructured the API documentation and moved it from the Reference section to the Developer guides section. Added a note about the search function to help users find the API they are looking for faster. Splitted the API docs into two files one for nanokernel and another for the microkernel APIs. Added table of contents for each of the API sections with a back link on the headings to take the users back to the top of the page. Making navigation easier and more user friendly. Change-Id: I80f415a60ea9c7df22276b464013e906e1efa511 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-02 01:28:50 +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: