zephyr/include
Henrik Brix Andersen deb1b455b9 drivers: can: improve API documentation
Improve the CAN driver API documentation:
- Reorder API declarations and organize them into logical groups.
- Add doxygen strings where missing.
- Improve and unify wording of existing doxygen strings.
- Unify naming of callback function pointers as "callback".
- Unify naming of user-specified callback function arguments as
  "user_data".
- Instances and pointers to struct zcan_frame are named "frame",
  not "msg", to avoid confusion with the CAN message queue support.
- Check for __DOXYGEN__ to include documentation for optional APIs in
  the documentation.
- Use "@cond INTERNAL_HIDDEN" to hide internal API details such as padding.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2021-12-07 15:39:06 -05:00
..
app_memory kernel: mem_domain: remove extra slash in Z_PROGBITS_SYM 2021-12-05 10:22:26 -05:00
arch xtensa: introduce support for GDB stub 2021-11-30 15:24:00 -05:00
audio audio: dmic: fix compile error on arm gcc 8 2021-02-16 15:29:16 +03:00
bluetooth Bluetooth: Mesh: Refactor Health Client into async API 2021-12-06 08:04:02 -05:00
canbus canbus: isotp: fix net_buf usage in recv function 2021-11-09 18:12:08 +02:00
console doc: Fix a few typos in docs/comments/messages 2021-09-03 06:06:59 -04:00
crypto device: Const-ify all device driver instance pointers 2020-09-02 13:48:13 +02:00
data json: Add top-level array decoding support 2021-12-01 12:21:19 -05:00
debug debug: gdbstub: add bits to restrict memory read/write 2021-11-30 15:24:00 -05:00
devicetree drivers: can: remove DT_CHOSEN_ZEPHYR_CANBUS_LABEL macro 2021-11-09 11:19:50 +01:00
dfu dfu: boot: Add implementation for multi-image swap type check 2021-08-26 09:13:13 -04:00
disk include: disk_access: Add a compat warning 2021-03-26 08:59:47 -04:00
display toolchain: migrate iterable sections calls to the external API 2021-08-12 17:47:04 -04:00
drivers drivers: can: improve API documentation 2021-12-07 15:39:06 -05:00
dt-bindings drivers: pwm_mcux: Update MCUX pwm driver to use clock bindings 2021-12-03 16:44:12 -06:00
fs fs: Add FS_MOUNT_FLAG_USE_DISK_ACCESS flag 2021-12-06 08:08:26 -05:00
ipc ipc_service: Extend RPMsg structs and misc fixes 2021-11-22 23:03:23 -05:00
kernel kernel: Swap RUNTIME_STATS implementation 2021-11-08 21:32:20 -05:00
linker Bluetooth: Mesh: Add common section for ext_adv 2021-12-02 09:23:54 +02:00
logging logging: Extend support for compilation with up to 31 arguments 2021-12-04 12:19:27 +01:00
lorawan lorawan: port oriented downlink callbacks 2021-04-30 13:05:10 -05:00
mgmt mgmt/mcumgr: Correct packet length information 2021-11-30 11:44:26 +01:00
modbus modbus: add raw ADU support 2021-03-19 15:50:21 +01:00
multi_heap multi_heap: Introduce shared multi-heap memory pool manager 2021-10-12 07:44:46 -04:00
net stats: i2c: I2C stats 2021-12-04 07:22:56 -05:00
pm pm: device_runtime: Use pm flags for runtime state 2021-12-06 13:41:25 -05:00
portability lib/os: bitarray: introduce SYS_BITARRAY_DEFINE_STATIC() 2021-11-24 14:22:23 -05:00
posix posix: semaphore: use ZRESTRICT 2021-11-05 13:29:31 +01:00
power pm: deprecate power/power.h header 2021-05-05 18:35:49 -04:00
random random: Add syscalls for random subsystem 2020-07-08 21:05:36 -04:00
settings toolchain: migrate iterable sections calls to the external API 2021-08-12 17:47:04 -04:00
shell shell: do not alias atomic_t 2021-11-17 12:25:10 +01:00
stats stats: i2c: I2C stats 2021-12-04 07:22:56 -05:00
storage storage/flash_map: Add FLASH_AREA_DEVICE macro 2021-11-06 21:37:47 -04:00
sys debug: gdbstub: add stubs to support breakpoint/watchpoint 2021-11-30 15:24:00 -05:00
task_wdt task_wdt: fix silent init failures 2021-10-01 15:21:32 +02:00
timing timing: guard the header with CONFIG_TIMING_FUNCTIONS 2021-04-06 16:43:55 -04:00
toolchain toolchain/xcc: Mark unsigned max as unsigned values for missing cases 2021-11-11 07:27:24 -05:00
tracing tracing: Fix k_fifo_put_list tracing for CONFIG_TRACING_NONE=yes 2021-12-01 05:03:43 -05:00
usb usb: Add API for getting status of remote wakeup 2021-11-09 13:50:03 +01:00
xen xenvm: drivers: serial: add interrupt-driven API for Xen PV console 2021-12-07 12:15:38 -05:00
zephyr zephyr: Remove support for deprecated int types 2021-03-05 04:56:13 -06:00
cache.h cache: Do not warn on unused parameters 2021-05-25 07:05:22 -05:00
device.h stats: i2c: I2C stats 2021-12-04 07:22:56 -05:00
devicetree.h devicetree: fix DT_FOREACH_STATUS_OKAY brief 2021-12-07 09:26:45 -06:00
ec_host_cmd.h include: Move ec_host_cmd.h to mgmt/ec_host_cmd.h 2021-04-22 12:51:16 -04:00
emul.h include: Move emul.h to drivers/emul.h 2021-04-22 12:51:01 -04:00
exc_handle.h
fatal.h
init.h init: tweak Zephyr .init* section name conflicting with toolchain 2021-04-26 14:15:43 -04:00
irq.h doc: fix display of the ISR_DIRECT_DECLARE example usage 2021-05-07 20:52:02 -04:00
irq_nextlevel.h device: Const-ify all device driver instance pointers 2020-09-02 13:48:13 +02:00
irq_offload.h irq_offload: Remove ifdef from the api 2021-04-29 14:50:35 +02:00
kernel.h Revert "Tracing: Tracing/Kernel dependency issue fix" 2021-11-17 10:17:43 -05:00
kernel_includes.h kernel: move internal headers into include/kernel 2021-06-16 20:38:55 -04:00
kernel_structs.h kernel/sched: Separate idle from app thread stats in THREAD_USAGE 2021-11-08 21:32:20 -05:00
kernel_version.h zephyr: replace zephyr integer types with C99 types 2020-06-08 08:23:57 -05:00
ptp_clock.h include: Move ptp_clock.h to drivers/ptp_clock.h 2021-03-25 10:09:33 +02:00
shared_irq.h drivers: intc: shared_irq: remove internal structs from header 2021-04-13 13:03:33 -04:00
smf.h lib: smf: Add State Machine Framework 2021-10-04 20:33:11 -04:00
spinlock.h kernel: fix usage of KERNEL_COHERENCE macro 2021-02-03 10:42:04 -05:00
sw_isr_table.h irq: Change dynamic API to take a constant parameter 2020-09-02 13:48:13 +02:00
sys_clock.h kernel: remove tickless idle 2021-03-19 11:22:17 -04:00
syscall.h kernel: syscall: pin generated inline functions 2021-08-26 21:16:22 -04:00
syscall_handler.h kernel: Cleanup logger setup in kernel files 2020-11-27 09:56:34 -05:00
timeout_q.h kernel/arch: cleanup function definitions 2021-04-01 05:34:17 -04:00
toolchain.h armclang: adding toolchain/armclang.h header 2021-08-30 08:54:23 -04:00
wait_q.h kernel: move internal headers into include/kernel 2021-06-16 20:38:55 -04:00
zephyr.h