zephyr/doc
Henrik Brix Andersen 8af4bb722d drivers: can: rename API functions for better consistency
Rename a few CAN API functions for clarity and consistency with other
Zephyr RTOS APIs.

CAN_DEFINE_MSGQ() becomes CAN_MSGQ_DEFINE() to match K_MSGQ_DEFINE().

can_attach_isr() becomes can_add_rx_filter() since a filter callback
function is not an interrupt service routine (although it is called in
isr context). The word "attach" is replaced with "add" since filters are
added, not attached. This matches the terminology used is other Zephyr
APIs better.

can_detach() becomes can_remove_rx_filter() to pair with
can_add_rx_filter().

can_attach_msgq() becomes can_add_rx_filter_msgq() and documentation is
updated to mention its relationship with can_add_rx_filter().

can_register_state_change_isr() becomes can_set_state_change_callback()
since a state change callback function is not an interrupt service
routine (although it is called in isr context). The word "register" is
replaced with "set" since only one state change callback can be in
place.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2022-01-10 10:44:37 +01:00
..
_doxygen doc: doxygen: adjust titles 2021-11-08 11:17:37 +01:00
_extensions/zephyr doc: extensions: link-roles: hide stderr for git describe 2021-12-10 16:48:43 -05:00
_scripts pm: device: Add wakeup source API 2021-08-11 19:39:13 -04:00
_static doc: css: update code documentation directives style 2022-01-05 14:38:24 +01:00
_templates doc: add a toctree with reference material 2021-11-02 13:24:40 +01:00
application doc: restore environment variables page 2021-12-14 13:28:20 +01:00
contribute doc: Fix typo for links to MAINTAINERS.yml 2021-12-09 11:21:56 -06:00
development_process doc: development_process: splitting up commits is justified 2021-12-18 10:42:49 +01:00
getting_started doc: drop single quote references 2021-12-10 16:43:34 -05:00
guides drivers: can: loopback: convert the CAN loopback driver to dts 2022-01-04 15:13:40 -06:00
images doc: remove unused images 2021-07-19 20:06:00 -04:00
introduction Bluetooth: Mesh: Align capitalization for BT mesh 2021-07-13 11:23:54 -04:00
reference drivers: can: rename API functions for better consistency 2022-01-10 10:44:37 +01:00
releases mcumgr: kconfig: Have OS_MGMT_TASKSTAT default to n 2022-01-04 11:54:28 +01:00
security doc: security: Remove unused image 2021-12-01 05:03:59 -05:00
templates
404.rst doc: fix 404 page 2021-05-19 16:48:39 -04:00
CMakeLists.txt doc: doxygen: add version and shorten brief 2021-10-07 11:54:23 -04:00
conf.py doc: do not use any as default role 2021-12-10 16:43:34 -05:00
copyright.rst
glossary.rst doc: reference: pm: move terms to glossary 2021-11-13 07:59:51 -05:00
index-tex.rst doc: create an index for PDF files 2021-07-15 07:07:21 -04:00
index.rst doc: add a toctree with reference material 2021-11-02 13:24:40 +01:00
known-warnings.txt doc: warnings: make expressions more generic 2021-05-19 06:21:53 -04:00
LICENSING.rst docs: Change a number of 'master' branch refers to 'main' 2021-05-28 10:45:17 -05:00
Makefile doc: makefile: add support for latexmk options 2021-07-30 08:21:02 -04:00
substitutions.txt
zephyr.doxyfile.in doc: debug: expand documentation on gdbstub 2021-11-30 15:24:00 -05:00