mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-16 12:16:06 +00:00
Doxygen comments for documenting structs have (known) issues, and the Breathe addon for Sphinx used to create our API docs has a known issue with forcing line breaks with @n or <br/> This patch tweaks the comments to use a method used in i2s.h to use @param comments for the members of a struct, and using 4 leading spaces (as done in i2s.h as well) to create a pre block for the bit-field layout comments. Fixes: #1415 Signed-off-by: David B. Kinder <david.b.kinder@intel.com> |
||
---|---|---|
.. | ||
arch | ||
bluetooth | ||
crypto | ||
debug | ||
dfu | ||
display | ||
drivers | ||
dt-bindings | ||
fs | ||
linker | ||
logging | ||
misc | ||
net | ||
shell | ||
toolchain | ||
usb | ||
zephyr | ||
adc.h | ||
aio_comparator.h | ||
atomic.h | ||
cache.h | ||
clock_control.h | ||
console.h | ||
counter.h | ||
crc16.h | ||
device.h | ||
disk_access.h | ||
dma.h | ||
eth.h | ||
flash.h | ||
fs.h | ||
gpio.h | ||
i2c.h | ||
i2s.h | ||
init.h | ||
ipm.h | ||
irq_offload.h | ||
irq.h | ||
kernel_version.h | ||
kernel.h | ||
pinmux.h | ||
power.h | ||
pthread.h | ||
pwm.h | ||
random.h | ||
rtc.h | ||
sensor.h | ||
shared_irq.h | ||
spi_legacy.h | ||
spi.h | ||
sw_isr_table.h | ||
sys_clock.h | ||
sys_io.h | ||
toolchain.h | ||
uart.h | ||
watchdog.h | ||
zephyr.h |