michaelh/zephyr
1
0
Fork 0
Code Releases Activity
zephyr/doc/reference/display/index.rst

38 lines
590 B
ReStructuredText
Raw Permalink Normal View History

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 00:48:18 +01:00
.. comment
not documenting
.. doxygengroup:: display_interfaces
doc: reference: Clean up and restructure a bit Name all subsystem reference consistently with an '_api' postfix and clean up naming and folder structure in some cases. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2020-03-13 19:02:31 +01:00
.. _display_api:
doc: display: cleanup display API page Make the reference consistent with other APIs and fixed heading. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-01 06:14:43 +01:00
Display Interface
#################
API Reference
*************
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-11-30 23:44:16 +01:00
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-30 23:52:57 +01:00
Generic Display Interface
doc: display: cleanup display API page Make the reference consistent with other APIs and fixed heading. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-01 06:14:43 +01:00
=========================
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-30 23:52:57 +01:00
.. 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-11-30 23:44:16 +01:00
Grove LCD Display
doc: display: cleanup display API page Make the reference consistent with other APIs and fixed heading. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-01 06:14:43 +01:00
=================
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-11-30 23:44:16 +01:00
.. doxygengroup:: grove_display
:project: Zephyr
BBC micro:bit Display
doc: display: cleanup display API page Make the reference consistent with other APIs and fixed heading. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-01 06:14:43 +01:00
=====================
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-11-30 23:44:16 +01:00
.. 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-02 23:21:56 +01:00
Monochrome Character Framebuffer
doc: display: cleanup display API page Make the reference consistent with other APIs and fixed heading. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-01 06:14:43 +01:00
================================
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-02 23:21:56 +01:00
.. doxygengroup:: monochrome_character_framebuffer
:project: Zephyr
Copy permalink