zephyr/doc/reference
Andrew Boie 6627249dc1 doc: simplify docs on driver-specific APIs.
This documentation is well-intentioned but not good advice.

The reason why we have a vtable-like API abstraction at the
driver subsystem level is to introduce object orientation.
The subsystem defintions implement an abstract class that
specific driver implementations all implement, providing
a common interface for end users. Multiple drivers may be
written for a subsystem that are interchangeable to the end
user.

However, there is no point in introducing a vtable-like
abstraction for APIs which are specific to a single driver.
We are not trying to present an interface abstraction which
could support multiple implementations. There is just one.

Simply declare a function in a header, and implement it in
the driver's C file.

Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
2020-04-26 20:29:01 -04:00
..
audio doc: reference: Add pages for audio 2020-03-18 11:47:24 +01:00
bluetooth Bluetooth: hci: Add documentation for Read/Set USB Transport Mode 2020-04-20 21:59:47 +03:00
crypto doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
devicetree include: devicetree.h: API for /chosen zephyr,foo 2020-04-13 09:14:21 -05:00
display doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
drivers doc: simplify docs on driver-specific APIs. 2020-04-26 20:29:01 -04:00
file_system doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
kernel riscv: Add support for floating point 2020-04-22 16:39:48 -07:00
logging doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
misc sys: add generic asynchronous notification infrastructure 2020-04-06 16:41:41 +02:00
networking doc: net: Add information about GSM 07.10 muxing support 2020-04-17 10:15:54 +03:00
peripherals drivers: dac: Add API for DAC peripherals 2020-04-20 17:41:48 +02:00
power_management doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01: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 doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
storage doc: dts: revisit documentation 2020-03-24 10:11:20 -05:00
usb USB: Add driver and PID for Bluetooth H4 2020-04-20 21:59:47 +03:00
usermode kernel: rename initializers to be internal 2020-04-24 22:27:08 +02:00
index.rst sys: add generic asynchronous notification infrastructure 2020-04-06 16:41:41 +02:00
overview.rst drivers: dac: Add API for DAC peripherals 2020-04-20 17:41:48 +02:00
terminology.rst doc: reference: terminology: refine API attributes 2020-04-22 17:39:56 +02:00