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/api.rst

29 lines
716 B
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
.. _api:
API Documentation
#################
doc: power_mgmt: Added Power Management documentation Documented the Power Management subsystem which includes the power management hook interface, device power management, device busy status interfac and other APIs. Also included is a guide to writing Power Management applications. This has 2 parts. One is the general description of the infrastructure and the PMA writing guide which goes in the 'subsystem' area. Other is the API description that gets automatically pulled in from the comments in the source files. The API description goes into the section where all other Zephyr APIs are put. Change-Id: Id630209b23f931a8fcccb6f59428610298486743 Signed-off-by: Ramesh Thomas <ramesh.thomas@intel.com>
2016-04-22 03:18:12 +08:00
Welcome to the Zephyr Project's :abbr:`API (Application Programing Interface)`
documentation.
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
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
doc: move device driver to a new section Put all device drivers and device model documentation into one section. Change-Id: Iba6a50796b02b7f9234c23dca706be62fd7b4259 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-28 05:31:44 +08:00
device.rst
doc: api: Include Bluetooth in API section Change-Id: Iee26587476b8f7286d2afe828ba23db49b09d0ce Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2016-06-15 15:27:40 +08:00
bluetooth.rst
doc: Include the I/O APIs in the documentation. Includes the I/O drivers' interfaces in the ReST documentation. Change-Id: I9ef70c4b0561c102b5c9425b4e41b5c813bf51b6 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-08 05:32:14 +08:00
io_interfaces.rst
doc: Edit the Event Logger APIs 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>
2016-02-08 02:00:52 +08:00
event_logger.rst
sys_log: adds system log documentation page Added sphynx comments required to link C code comments to rst documentation, additionally a new rest page with the list of current system log Kconfig options and an example. Change-Id: I9d1370b5f0a2fbd858de83befb99f0f4c7024a13 Signed-off-by: Genaro Saucedo Tejada <genaro.saucedo.tejada@intel.com> JIRA: ZEP-153
2016-06-02 01:20:38 +08:00
system_log.rst
doc: power_mgmt: Added Power Management documentation Documented the Power Management subsystem which includes the power management hook interface, device power management, device busy status interfac and other APIs. Also included is a guide to writing Power Management applications. This has 2 parts. One is the general description of the infrastructure and the PMA writing guide which goes in the 'subsystem' area. Other is the API description that gets automatically pulled in from the comments in the source files. The API description goes into the section where all other Zephyr APIs are put. Change-Id: Id630209b23f931a8fcccb6f59428610298486743 Signed-off-by: Ramesh Thomas <ramesh.thomas@intel.com>
2016-04-22 03:18:12 +08:00
power_management_api
doc: Restructure top level sections. Restructures the top level sections to ease finding information. Change-Id: I09de0a0d665fc77dea92797be8ef29970fe8a393 Jira: ZEP-245 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-05-16 22:33:57 +08:00