docu: updated titles of examples

This commit is contained in:
Milanka Ringwald 2020-10-21 11:06:03 +02:00
parent 808187d876
commit 13820c00da
13 changed files with 16 additions and 13 deletions

View File

@ -42,7 +42,7 @@
*/ */
// ***************************************************************************** // *****************************************************************************
/* EXAMPLE_START(a2dp_sink_demo): Receive audio stream and control its playback. /* EXAMPLE_START(a2dp_sink_demo): Audio stream reception and playback control
* *
* @text This A2DP Sink example demonstrates how to use the A2DP Sink service to * @text This A2DP Sink example demonstrates how to use the A2DP Sink service to
* receive an audio data stream from a remote A2DP Source device. In addition, * receive an audio data stream from a remote A2DP Source device. In addition,

View File

@ -42,7 +42,7 @@
*/ */
// ***************************************************************************** // *****************************************************************************
/* EXAMPLE_START(a2dp_source_demo): Serve audio stream and handle remote playback control and queries. /* EXAMPLE_START(a2dp_source_demo): Audio streaming and remote playback control
* *
* @text This A2DP Source example demonstrates how to send an audio data stream * @text This A2DP Source example demonstrates how to send an audio data stream
* to a remote A2DP Sink device and how to switch between two audio data sources. * to a remote A2DP Sink device and how to switch between two audio data sources.

View File

@ -38,7 +38,7 @@
#define BTSTACK_FILE__ "dut_mode_classic.c" #define BTSTACK_FILE__ "dut_mode_classic.c"
// ***************************************************************************** // *****************************************************************************
/* EXAMPLE_START(dut_mode_classic): Enable Device Under Test (DUT) Mode for BR/EDR /* EXAMPLE_START(dut_mode_classic): Testing - Enable Device Under Test (DUT) Mode for BR/EDR
* *
* @text DUT mode can be used for production testing. This example just configures * @text DUT mode can be used for production testing. This example just configures
* the Bluetooth Controller for DUT mode. * the Bluetooth Controller for DUT mode.

View File

@ -38,7 +38,7 @@
#define BTSTACK_FILE__ "gatt_streamer.c" #define BTSTACK_FILE__ "gatt_streamer.c"
// ***************************************************************************** // *****************************************************************************
/* EXAMPLE_START(le_streamer): LE Streamer - Stream data over GATT. /* EXAMPLE_START(le_streamer): Performance - Stream data over GATT
* *
* @text All newer operating systems provide GATT Client functionality. * @text All newer operating systems provide GATT Client functionality.
* This example shows how to get a maximal throughput via BLE: * This example shows how to get a maximal throughput via BLE:

View File

@ -42,7 +42,10 @@
*/ */
// ***************************************************************************** // *****************************************************************************
/* EXAMPLE_START(le_streamer_client): Connects to 'LE Streamer' and subscribes to test characteristic /* EXAMPLE_START(le_streamer_client): Performance - LE Streamer Client
*
* @text Connects to 'LE Streamer' and subscribes to test characteristic
*
*/ */
// ***************************************************************************** // *****************************************************************************

View File

@ -38,7 +38,7 @@
#define BTSTACK_FILE__ "led_counter.c" #define BTSTACK_FILE__ "led_counter.c"
// ***************************************************************************** // *****************************************************************************
/* EXAMPLE_START(led_counter): Hello World: blinking LED without Bluetooth /* EXAMPLE_START(led_counter): Hello World - Blinking LED without Bluetooth
* *
* @text The example demonstrates how to provide a periodic timer to toggle an * @text The example demonstrates how to provide a periodic timer to toggle an
* LED and send debug messages to the console as a minimal BTstack test. * LED and send debug messages to the console as a minimal BTstack test.

View File

@ -42,7 +42,7 @@
* Author: Ole Reinhardt <ole.reinhardt@kernelconcepts.de> * Author: Ole Reinhardt <ole.reinhardt@kernelconcepts.de>
*/ */
/* EXAMPLE_START(panu_demo): PANU Demo /* EXAMPLE_START(panu_demo): BNEP/PANU Demo
* *
* @text This example implements both a PANU client and a server. In server mode, it * @text This example implements both a PANU client and a server. In server mode, it
* sets up a BNEP server and registers a PANU SDP record and waits for incoming connections. * sets up a BNEP server and registers a PANU SDP record and waits for incoming connections.

View File

@ -38,7 +38,7 @@
#define BTSTACK_FILE__ "sdp_bnep_query.c" #define BTSTACK_FILE__ "sdp_bnep_query.c"
// ***************************************************************************** // *****************************************************************************
/* EXAMPLE_START(sdp_bnep_query): Dump remote BNEP PAN protocol UUID and L2CAP PSM /* EXAMPLE_START(sdp_bnep_query): SDP Records - Dump BNEP PAN protocol
* *
* @text The example shows how the SDP Client is used to get all BNEP service * @text The example shows how the SDP Client is used to get all BNEP service
* records from a remote device. It extracts the remote BNEP PAN protocol * records from a remote device. It extracts the remote BNEP PAN protocol

View File

@ -38,7 +38,7 @@
#define BTSTACK_FILE__ "sdp_general_query.c" #define BTSTACK_FILE__ "sdp_general_query.c"
// ***************************************************************************** // *****************************************************************************
/* EXAMPLE_START(sdp_general_query): Dump remote SDP Records /* EXAMPLE_START(sdp_general_query): SDP Records Dump
* *
* @text The example shows how the SDP Client is used to get a list of * @text The example shows how the SDP Client is used to get a list of
* service records on a remote device. * service records on a remote device.

View File

@ -39,7 +39,7 @@
// ***************************************************************************** // *****************************************************************************
/* EXAMPLE_START(sm_pairing_central): LE Peripheral - Test pairing combinations /* EXAMPLE_START(sm_pairing_central): LE Central - Test pairing combinations
* *
* @text Depending on the Authentication requiremens and IO Capabilities, * @text Depending on the Authentication requiremens and IO Capabilities,
* the pairing process uses different short and long term key generation method. * the pairing process uses different short and long term key generation method.

View File

@ -38,7 +38,7 @@
#define BTSTACK_FILE__ "spp_and_gatt_counter.c" #define BTSTACK_FILE__ "spp_and_gatt_counter.c"
// ***************************************************************************** // *****************************************************************************
/* EXAMPLE_START(spp_and_le_counter): Dual mode example /* EXAMPLE_START(spp_and_le_counter): Dual mode - SPP and LE Counter
* *
* @text The SPP and LE Counter example combines the Bluetooth Classic SPP Counter * @text The SPP and LE Counter example combines the Bluetooth Classic SPP Counter
* and the Bluetooth LE Counter into a single application. * and the Bluetooth LE Counter into a single application.

View File

@ -42,7 +42,7 @@
*/ */
// ***************************************************************************** // *****************************************************************************
/* EXAMPLE_START(spp_streamer): Send test data via SPP as fast as possible. /* EXAMPLE_START(spp_streamer): Performance - Stream data over SPP
* *
* @text After RFCOMM connections gets open, request a * @text After RFCOMM connections gets open, request a
* RFCOMM_EVENT_CAN_SEND_NOW via rfcomm_request_can_send_now_event(). * RFCOMM_EVENT_CAN_SEND_NOW via rfcomm_request_can_send_now_event().

View File

@ -42,7 +42,7 @@
*/ */
// ***************************************************************************** // *****************************************************************************
/* EXAMPLE_START(spp_streamer_client): Client for SPP Streamer /* EXAMPLE_START(spp_streamer_client): Performance - SPP Streamer Client
* *
* @text Note: The SPP Streamer Client scans for and connects to SPP Streamer, * @text Note: The SPP Streamer Client scans for and connects to SPP Streamer,
* and measures the throughput. * and measures the throughput.