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

16 lines
489 B
Plaintext
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
#
#
# include
#
doc: known issues: Fix regexes for Windows Fix the regexes in the known issues database so that they work on Winndows machines with different path formats. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-07-12 19:12:09 +08:00
^(?P<filename>([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]misc_api.rst):(?P<lineno>[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+]
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
^[ \t]*
^[ \t]*\^
^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+]
^[ \t]*
^[ \t]*\^
^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected end of definition. \[error at [0-9]+]
^.*json_obj_descr.__unnamed__
^[- \t]*\^