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

33 lines
569 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
.. _display_api:
doc: add comment for API doxygen group check add a comment for the scanner script for missing API doxygengroup directives so it won't complain about a parent defgroup used only for organization Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-03 07:48:18 +08:00
.. comment
not documenting
.. doxygengroup:: display_interfaces
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 Interface APIs
######################
doc: Added generic display interface to API doc Added generic display interface to Display Interfaces APIs documentation Signed-off-by: Jan Van Winkel <jan.van_winkel@dxplore.eu>
2018-10-31 06:52:57 +08:00
Generic Display Interface
*************************
.. doxygengroup:: display_interface
:project: Zephyr
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
Grove LCD Display
*****************
.. doxygengroup:: grove_display
:project: Zephyr
BBC micro:bit Display
*********************
.. doxygengroup:: mb_display
:project: Zephyr
doc: add missing cfb API As mentioned in issue #12265, this API wasn't included in the generated API docs because a doxygengroup directive was missing. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-03 06:21:56 +08:00
Monochrome Character Framebuffer
********************************
.. doxygengroup:: monochrome_character_framebuffer
:project: Zephyr