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

22 lines
348 B
ReStructuredText
Raw Normal View History

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:
File System APIs
#####################
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
.. comment
not documenting
.. doxygengroup:: file_system
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 Functions
*******************************
.. doxygengroup:: file_system_api
:project: Zephyr
File System Data Structures
*******************************
.. doxygengroup:: data_structures
:project: Zephyr