bartoszek/zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
39298cf3c5
zephyr/include
History
David B. Kinder 621ac8f84b doc: add missing API content 
Some API material (from doxygen comments) wasn't included in the
generated documentation because there was no doxygengroup Sphinx
directive to display them. This PR add content into appropriate places
in existing documentation (e.g., Bluetooth Cryptography APIs into the
Bluetooth API doc) and creates two new collections for Display and
Miscellaneous APIs.

Comments added to the .rst files to mention doxygengroups that are
intentionally excluded (because they're organizational groups containing
subgroups that are included).

Sorted the Bluetooth API list, mostly.

Fixed a couple doxygen group titles defined in the include files, and
added a few patterns to filter new "expected" errors from the document
generation process.

Legacy and deprecated APIs remain left out, as intended:

   http_legacy  (net/http_legacy.h)
   spi_interface_legacy  (spi_legacy.h)
   zoap  (net/zoap.h)

fixes: Issue #5051

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-12-01 08:58:56 -05:00
..
arch arm: define _image_rodata_start/end 2017-11-28 12:29:13 -05:00
bluetooth Bluetooth: Mesh: Improve documentation for model publication 2017-11-27 12:10:49 +02:00
crypto crypto: Remove useless attribute 2017-04-27 13:06:31 +00:00
debug object_tracing: fix definition 2017-08-16 10:59:10 -07:00
dfu DFU: add module for store the image 2017-09-11 11:37:43 -04:00
display doc: APIs: group display drivers 2017-11-17 17:14:18 -05:00
drivers jailhouse: add support for x2APIC mode for all LOAPIC accesses 2017-11-07 08:58:49 -05:00
dt-bindings clock_control: Introduce mcux ccm driver 2017-11-15 09:09:58 -06:00
fs subsys: fs: consolidate elm FAT kconfig options 2017-10-03 08:43:50 -04:00
linker linker: use UTIL_LISTIFY macro for dealing with .a files 2017-11-08 20:00:22 -05:00
logging cleanup: rename fiber/task -> thread 2017-10-30 18:41:15 -04:00
misc stack_unused_space_get: account for sentinel 2017-11-14 10:39:16 -08:00
net net: pkt: Compute TX payload data length 2017-11-24 08:27:39 -05:00
random subsys: Add random subsystem 2017-11-01 08:26:29 -04:00
shell shell: Add optional command description 2017-11-15 07:51:02 +02:00
toolchain syscalls: REVERTME: clean up warnings when building unit tests 2017-11-15 19:09:12 -05:00
usb include: usb: remove cdc_acm.h 2017-11-07 15:31:02 -05:00
zephyr Introduce new sized integer typedefs 2017-04-20 16:07:08 +00:00
adc.h drivers: adc: add system call handlers 2017-10-30 13:20:19 -07:00
aio_comparator.h drivers: aio_comparator: add system calls 2017-10-30 13:20:19 -07:00
atomic.h license: Replace Apache boilerplate with SPDX tag 2017-01-19 03:50:58 +00:00
cache.h license: Replace Apache boilerplate with SPDX tag 2017-01-19 03:50:58 +00:00
clock_control.h Convert remaining code to using newly introduced integer sized types 2017-04-21 11:38:23 -05:00
console.h doc: fix misspellings in include (API docs) 2017-08-10 12:22:19 -04:00
counter.h doc: add missing API content 2017-12-01 08:58:56 -05:00
crc16.h doc: crc16: add to doxygen group 2017-11-22 13:27:01 -05:00
device.h Convert remaining code to using newly introduced integer sized types 2017-04-21 11:38:23 -05:00
disk_access.h Convert remaining code to using newly introduced integer sized types 2017-04-21 11:38:23 -05:00
dma.h drivers: dma: remove deprecated API functions 2017-09-22 07:50:20 -04:00
entropy.h drivers: Rename random to entropy 2017-11-01 08:26:29 -04:00
eth.h Convert remaining code to using newly introduced integer sized types 2017-04-21 11:38:23 -05:00
flash.h flash: minor documentation improvements. 2017-11-28 12:25:19 -05:00
fs.h doc: add missing API content 2017-12-01 08:58:56 -05:00
gpio.h drivers: gpio: deprecate GPIO_PIN_ENABLE, GPIO_PIN_DISABLE 2017-11-02 18:46:30 -04:00
i2c.h drivers: i2c: add system call handlers 2017-10-30 13:20:19 -07:00
i2s.h doc: replace UTF-8 chars 2017-10-03 20:03:57 -04:00
init.h kernel: remove deprecated init levels 2017-04-07 17:45:34 +00:00
ipm.h drivers: ipm: add system calls 2017-10-30 13:20:19 -07:00
irq_offload.h license: Replace Apache boilerplate with SPDX tag 2017-01-19 03:50:58 +00:00
irq.h irq.h: include generic toolchain header 2017-08-16 10:59:10 -07:00
json.h doc: json: add to doxygen group 2017-11-22 13:27:01 -05:00
kernel_version.h Convert remaining code to using newly introduced integer sized types 2017-04-21 11:38:23 -05:00
kernel.h kernel: Remove deprecated k_mem_pool_defrag code 2017-11-28 15:23:22 -05:00
led_strip.h drivers: led_strip: add public API for addressable LED strips 2017-10-28 13:23:30 -04:00
pinmux.h drivers: pinmux: add system call handlers 2017-10-30 13:20:19 -07:00
power.h Convert remaining code to using newly introduced integer sized types 2017-04-21 11:38:23 -05:00
pthread.h kernel: POSIX thread IPC support 2017-08-15 19:42:07 -04:00
pwm.h drivers: pwm: add system call handlers 2017-10-30 13:20:19 -07:00
rtc.h drivers: rtc: add system calls 2017-10-30 13:20:19 -07:00
sensor.h drivers: sensor: Fix some code style issues 2017-11-27 22:17:38 -05:00
shared_irq.h Convert remaining code to using newly introduced integer sized types 2017-04-21 11:38:23 -05:00
spi_legacy.h api: New SPI API 2017-05-19 18:52:25 -04:00
spi.h drivers: spi: add system call handlers 2017-10-30 13:20:19 -07:00
sw_isr_table.h sw_isr_table.h: fix includes 2017-10-27 16:08:54 -04:00
sys_clock.h kernel: tickless: Add tickless kernel support 2017-04-27 13:46:28 +00:00
sys_io.h sys_io.h: don't pull in kernel.h 2017-11-02 13:25:01 -07:00
syscall.h kernel: allow system call with 64-bit return val 2017-10-12 16:25:00 -07:00
toolchain.h xtensa: move byte-order macros out of arch.h 2017-05-11 12:47:23 -04:00
uart.h drivers: uart: add system call handlers 2017-10-30 13:20:19 -07:00
watchdog.h Convert remaining code to using newly introduced integer sized types 2017-04-21 11:38:23 -05:00
zephyr.h kernel: remove legacy.h and MDEF support 2017-04-19 10:59:35 -05:00