update examples docu

example/dut_mode_classic.c

@@ -41,7 +41,7 @@
 /* EXAMPLE_START(dut_mode_classic): Enable Device Under Test (DUT) Mode for BR/EDR
  *
  * @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.
  */
 // *****************************************************************************
 

example/le_streamer.c

@@ -38,7 +38,7 @@
 #define __BTSTACK_FILE__ "le_streamer.c"
 
 // *****************************************************************************
-/* EXAMPLE_START(le_streamer): LE Peripheral - Stream data over GATT
+/* EXAMPLE_START(le_streamer): LE Streamer - Stream data over GATT.
  *
  * @text All newer operating systems provide GATT Client functionality.
  * This example shows how to get a maximal throughput via BLE:
@@ -49,8 +49,8 @@
  * a connection interval of 30 ms and there's no public way to use a shorter 
  * interval with iOS (if we're not implementing an HID device).
  *
- * @text Note: To start the streaming, please run the le_streamer_client example 
- * on other device, or use some GATT Explorer, e.g. LightBlue, BLExplr.
+ * @text Note: To start the streaming, run the example.
+ * On remote device use some GATT Explorer, e.g. LightBlue, BLExplr to enable notifications.
  */
  // *****************************************************************************
 

example/panu_demo.c

@@ -48,6 +48,8 @@
  * sets up a BNEP server and registers a PANU SDP record and waits for incoming connections.
  * In client mode, it connects to a remote device, does an SDP Query to identify the PANU
  * service and initiates a BNEP connection.
+ *
+ * Note: currently supported only on Linux and Mac.
  */
 
 #include "btstack_config.h"

example/pbap_client_demo.c

@@ -39,6 +39,10 @@
 
 // *****************************************************************************
 /* EXAMPLE_START(pbap_client_demo): Connect to Phonebook Server and get contacts.
+ *
+ * @text Note: The Bluetooth address of the remote Phonbook server is hardcoded. 
+ * Change it before running example, then use the UI to connect to it, to set and 
+ * query contacts.
  */
 // *****************************************************************************
 

example/spp_and_le_counter.c

@@ -43,8 +43,12 @@
  * @text The SPP and LE Counter example combines the Bluetooth Classic SPP Counter
  * and the Bluetooth LE Counter into a single application.
  *
- * In this Section, we only point out the differences to the individual examples
- * and how how the stack is configured.
+ * @text In this Section, we only point out the differences to the individual examples
+ * and how the stack is configured.
+ *
+ * @text Note: To test, please run the example, and then: 
+ *    - for SPP pair from a remote device, and open the Virtual Serial Port,
+ *    - for LE use some GATT Explorer, e.g. LightBlue, BLExplr, to enable notifications.
  */
 // *****************************************************************************
 

example/spp_and_le_streamer.c

@@ -41,8 +41,13 @@
  * @text The SPP and LE Streamer example combines the Bluetooth Classic SPP Streamer
  * and the Bluetooth LE Streamer into a single application.
  *
- * In this Section, we only point out the differences to the individual examples
+ * @text In this Section, we only point out the differences to the individual examples
  * and how how the stack is configured.
+ *
+ * @text Note: To test, please run the example, and then: 
+ *    - for SPP pair from a remote device, and open the Virtual Serial Port,
+ *    - for LE use some GATT Explorer, e.g. LightBlue, BLExplr, to enable notifications.
+ *
  */
 // *****************************************************************************
 

example/spp_counter.c

@@ -43,6 +43,9 @@
  * @text The Serial port profile (SPP) is widely used as it provides a serial
  * port over Bluetooth. The SPP counter example demonstrates how to setup an SPP
  * service, and provide a periodic timer over RFCOMM.   
+ *
+ * @text Note: To test, please run the spp_counter example, and then pair from 
+ * a remote device, and open the Virtual Serial Port.
  */
 // *****************************************************************************
 

example/spp_streamer.c

@@ -42,11 +42,14 @@
  */
 
 // *****************************************************************************
-/* EXAMPLE_START(spp_streamer): Send test data via SPP as fast as possible
+/* EXAMPLE_START(spp_streamer): Send test data via SPP as fast as possible.
  * 
  * @text After RFCOMM connections gets open, request a
  * RFCOMM_EVENT_CAN_SEND_NOW via rfcomm_request_can_send_now_event().
- * When we get the RFCOMM_EVENT_CAN_SEND_NOW, send data and request another one.
+ * @text When we get the RFCOMM_EVENT_CAN_SEND_NOW, send data and request another one.
+ *
+ * @text Note: To test, run the example, pair from a remote 
+ * device, and open the Virtual Serial Port.
  */
 // *****************************************************************************
 

example/spp_streamer_client.c

@@ -44,8 +44,8 @@
 // *****************************************************************************
 /* EXAMPLE_START(spp_streamer_client): Client for SPP Streamer
  * 
- * @text The SPP Streamer Clients connects to SPP Streamer and tracks the 
- * amount of received data
+ * @text Note: The SPP Streamer Client scans for and connects to SPP Streamer,
+ * and measures the throughput.
  */
 // *****************************************************************************