zephyr/doc/reference
Nicolas Pitre 68d1ccc190 ring_buffer: documentation fixes
The documentation was somewhat confused. Bring it closer to reality.

The SIZE32_OF() usage, while not wrong per se, is not as clear as
using the number of words directly. Let's favor the later to make the
documentation clearer.

Signed-off-by: Nicolas Pitre <npitre@baylibre.com>
2022-02-24 14:49:00 -08:00
..
api doc: reference: api: overview: note that the CAN API was changed in v3.0 2022-01-01 07:40:41 -05:00
audio doc: use kconfig role and directive 2021-06-29 10:26:28 -04:00
bluetooth Bluetooth: Mesh: Add mesh shell command 2022-02-24 13:51:09 -08:00
canbus drivers: can: rename API functions for better consistency 2022-01-10 10:44:37 +01:00
crypto
data_structures ring_buffer: documentation fixes 2022-02-24 14:49:00 -08:00
devicetree doc: devicetree: fix broken link in api.rst 2022-02-03 14:01:25 -06:00
display
drivers doc: reference: drivers: update system drivers section 2021-12-24 20:59:10 -05:00
edac doc: reference: reword a few titles 2021-12-15 14:59:21 -05:00
file_system
iterable_sections doc: fix C domain reference usage 2021-10-26 10:57:45 +02:00
kernel doc: spinlock: ensure spinlock api is added to doxygen 2022-02-02 08:57:14 -05:00
libc doc: use kconfig role and directive 2021-06-29 10:26:28 -04:00
logging doc: logging: Add section about stack usage 2022-02-22 14:44:11 +01:00
memory_management doc: add a page for the new memory blocks allocator 2022-01-11 16:10:53 -05:00
misc doc: formatted_output: update header field descriptions 2022-02-18 08:31:47 -05:00
modbus doc: reference: reword a few titles 2021-12-15 14:59:21 -05:00
networking net: introduce a network packet filter framework 2021-12-21 17:06:35 +01:00
peripherals docs: api: uart: Restructure and provide introduction 2022-01-07 14:01:12 -05:00
pinctrl doc: reference: add pinctrl API 2021-10-25 15:26:47 -05:00
pm doc: reference: pm: include all API and move to pm 2021-11-13 07:59:51 -05:00
random random: deprecate XOROSHIRO_RANDOM_GENERATOR 2021-08-05 11:24:44 +02:00
resource_management
settings doc: note on the settings for the secure-domain 2021-12-23 12:39:20 +01:00
shell doc: shell getopt support 2022-01-06 21:26:59 +01:00
storage doc: fix C domain reference usage 2021-10-26 10:57:45 +02:00
task_wdt doc: use kconfig role and directive 2021-06-29 10:26:28 -04:00
timing_functions doc: use kconfig role and directive 2021-06-29 10:26:28 -04:00
usb doc: reference: reword a few titles 2021-12-15 14:59:21 -05:00
usermode doc: misc fixes 2021-10-04 16:42:08 -04:00
util
virtualization doc: use kconfig role and directive 2021-06-29 10:26:28 -04:00
index.rst doc: reference: include two levels of titles in the toc 2021-12-15 14:59:21 -05:00