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

37 lines
629 B
ReStructuredText
Raw Normal View History

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
.. _misc_api:
doc: reference: reword a few titles Reword a few of the reference documentation titles to better fit in with the rest. Do not use all-caps MODBUS for title. Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2021-12-14 06:21:01 +08:00
Miscellaneous
#############
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:: checksum
.. doxygengroup:: structured_data
Checksum APIs
*************
crc: move all crc APIs into one header Move all CRC APIs into one single header. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-12-02 22:51:26 +08:00
CRC
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
=====
crc: move all crc APIs into one header Move all CRC APIs into one single header. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-12-02 22:51:26 +08:00
.. doxygengroup:: crc
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
Structured Data APIs
********************
JSON
====
.. doxygengroup:: json
jwt: Add JSON web token library This patch adds a JSON web token library that adds the capability to sign JSON tokens. This was located in subsys due to the dependency on MBEDTLS, which resides in /ext. Signed-off-by: David Brown <david.brown@linaro.org> Signed-off-by: Andy Gross <andy.gross@linaro.org>
2018-09-21 03:15:20 +08:00
JWT
===
JSON Web Tokens (JWT) are an open, industry standard [RFC
7519](https://tools.ietf.org/html/rfc7519) method for representing
claims securely between two parties. Although JWT is fairly flexible,
this API is limited to creating the simplistic tokens needed to
authenticate with the Google Core IoT infrastructure.
.. doxygengroup:: jwt