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

32 lines
689 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
doc: Incorporate kernel APIs into API documentation guide Change-Id: Ib5e5aa14534af4789d8247e6096913e09731f5bb Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-11-16 03:38:39 +08:00
code. If you are looking for a specific API, enter it on the search box.
The search results display all sections containing information
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
about that API.
doc: Incorporate kernel APIs into API documentation guide Change-Id: Ib5e5aa14534af4789d8247e6096913e09731f5bb Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-11-16 03:38:39 +08:00
The Zephyr APIs are used the same way on all SoCs and boards.
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
.. toctree::
:maxdepth: 2
doc: Incorporate kernel APIs into API documentation guide Change-Id: Ib5e5aa14534af4789d8247e6096913e09731f5bb Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-11-16 03:38:39 +08:00
kernel_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 main Network APIs doxygen documentation Added missing dogygen definitions. Jira: ZEP-1495 Change-Id: Ibc087f3f174b8af45b0726c0d82b77feff36d4e3 Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
2017-01-06 21:10:06 +08:00
networking.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
drivers: watchdog: Watchdog API redesign New API enables setting watchdog timeout in the unit of microseconds. It is possible to configure watchdog timer behavior in CPU sleep state as well as when it is halted by the debugger. It supports watchdogs with multiple reload channels. Jira: ZEP-2564 Signed-off-by: Michał Kruszewski <michal.kruszewski@nordicsemi.no> Signed-off-by: Karol Lasończyk <karol.lasonczyk@nordicsemi.no>
2017-08-24 23:35:08 +08:00
timer_counter_interfaces.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: Add file system documentation Adds documentation of file system APIs Jira: ZEP-643 Change-Id: Ieac14a3dcf4913aeba6da2d3dc718eaa09b6cd88 Signed-off-by: Ramesh Thomas <ramesh.thomas@intel.com>
2016-08-05 11:42:46 +08:00
file_system
doc: add missing API content Some API material (from doxygen comments) wasn't included in the generated documentation because there was no doxygengroup Sphinx directive to display them. This PR add content into appropriate places in existing documentation (e.g., Bluetooth Cryptography APIs into the Bluetooth API doc) and creates two new collections for Display and Miscellaneous APIs. Comments added to the .rst files to mention doxygengroups that are intentionally excluded (because they're organizational groups containing subgroups that are included). Sorted the Bluetooth API list, mostly. Fixed a couple doxygen group titles defined in the include files, and added a few patterns to filter new "expected" errors from the document generation process. Legacy and deprecated APIs remain left out, as intended: http_legacy (net/http_legacy.h) spi_interface_legacy (spi_legacy.h) zoap (net/zoap.h) fixes: Issue #5051 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-12-01 06:44:16 +08:00
display_api
misc_api
doc: subsys: logging: Add documentation for new logger Documentation for new logger subsystem. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2018-06-29 20:20:45 +08:00
logger_api
doc: subsystems: shell: Add documentation. 1. Remove old shell documentation. 2. Create documentation for new shell module. 3. Fix shell.h comments to be able to generate API documentation. Signed-off-by: Jakub Rzeszutko <jakub.rzeszutko@nordicsemi.no>
2018-09-24 21:18:52 +08:00
shell_api
doc: usb: Move generated api to the right place Move USB API to the right place. Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
2018-10-03 17:48:17 +08:00
usb_api