zephyr/doc/reference
Martí Bolívar 04df8124ac api: promote sys/util.h to experimental
This file contains definitions for macros which are integral to
significant Zephyr use cases, such as CONTAINER_OF() and various
macros used by devicetree.h internally.

As such, in practice we expect at least advanced (if not intermediate)
users to understand it, so the fact that it's not formally documented
as an API with a stability level is a problem.

Fix that by giving the docstrings a once-over and adding new ones
where they are missing. Move all the remaining non-API macros to
util_internal.h.

Add a Sphinx API page for this header, and include it in the API
overview at "experimental" stability level.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-06-18 19:38:10 +02:00
..
audio doc: reference: Move i2s reference to Audio section 2020-06-12 10:29:24 -04:00
bluetooth Bluetooth: doc: Include gap.h and addr.h in documentation build 2020-04-30 13:34:28 +02:00
crypto doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
devicetree doc: dts: simplify DT_INST documentation 2020-05-26 22:32:34 +02:00
display doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
drivers docs: drivers: remove suggestion to assign driver_api in init function 2020-06-16 10:46:39 -05:00
file_system doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
kernel zephyr: replace zephyr integer types with C99 types 2020-06-08 08:23:57 -05:00
logging logging: Clarify that hexdump messages have no function prefix 2020-06-16 19:05:51 +02:00
misc doc: reference: misc: highlight userspace restriction on sys_notify 2020-05-20 10:34:17 +02:00
networking net: lwm2m: Add ObjLnk resource type support 2020-06-15 22:13:34 +03:00
peripherals doc: reference: Move i2s reference to Audio section 2020-06-12 10:29:24 -04:00
power_management zephyr: replace zephyr integer types with C99 types 2020-06-08 08:23:57 -05:00
random doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
resource_management sys: onoff: redesign to meet changed needs 2020-04-22 16:52:47 +02:00
settings doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
shell zephyr: replace zephyr integer types with C99 types 2020-06-08 08:23:57 -05:00
storage storage: add stream flash library 2020-05-06 11:14:00 +02:00
usb USB: Add driver and PID for Bluetooth H4 2020-04-20 21:59:47 +03:00
usermode zephyr: replace zephyr integer types with C99 types 2020-06-08 08:23:57 -05:00
util api: promote sys/util.h to experimental 2020-06-18 19:38:10 +02:00
index.rst api: promote sys/util.h to experimental 2020-06-18 19:38:10 +02:00
overview.rst api: promote sys/util.h to experimental 2020-06-18 19:38:10 +02:00
terminology.rst doc: reference: terminology: refine API attributes 2020-04-22 17:39:56 +02:00