From a5e1b78141b644b62a933bee77213bbe2f7b79ca Mon Sep 17 00:00:00 2001 From: Rodrigo Caballero Date: Wed, 14 Oct 2015 09:40:41 -0500 Subject: [PATCH] doc: Changed the API table in the Bluetooth document. Changed the existing API table to a list as it was done in the Kernel Primer. Change-Id: Ib0d7952c650316b414ac9258ab3c48e9f6c70c4e Signed-off-by: Rodrigo Caballero --- doc/kernel/networking/bluetooth.rst | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/doc/kernel/networking/bluetooth.rst b/doc/kernel/networking/bluetooth.rst index c644a1f9aaa..77f487d853f 100644 --- a/doc/kernel/networking/bluetooth.rst +++ b/doc/kernel/networking/bluetooth.rst @@ -6,23 +6,22 @@ Bluetooth Implementation Initialization ************** -Initialize the Bluetooth subsystem using :c:func:`bt_init()`. Caller shall be -either task or a fiber. Caller must ensure that function succeeds by checking -return code for errors. +Initialize the Bluetooth subsystem using :c:func:`bt_init()`. Caller shall +be either task or a fiber. Caller must ensure that function succeeds by +checking return code for errors. -Application Program Interfaces -****************************** +APIs +**** -+------------------------------------------+------------------------------------------------------+ -| Call | Description | -+==========================================+======================================================+ -| :c:func:`bt_init()` | Initializes the Bluetooth subsystem | -+------------------------------------------+------------------------------------------------------+ -| :c:func:`bt_start_advertising()` | Set advertisement and scan data and start | -| | advertising | -+------------------------------------------+------------------------------------------------------+ +The following Bluetooth APIs are provided: -TODO: Describe all API +:c:func:`bt_init()` + Initializes the Bluetooth subsystem. + +:c:func:`bt_start_advertising()` + Sets up advertisement, scans for data, and starts advertising. + +.. todo:: Describe all API Bluetooth Application Example *****************************