xiao sun / BLE_API

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of BLE_API by Bluetooth Low Energy

Diff: GapAdvertisingParams.h

Revision:
21:5442f7c70e71
Parent:
18:86fe1e247a54
Child:
27:4a83843f04b0
diff -r c6ceaa206674 -r 5442f7c70e71 GapAdvertisingParams.h
--- a/GapAdvertisingParams.h	Thu Dec 19 14:02:49 2013 +0000
+++ b/GapAdvertisingParams.h	Tue Jan 07 10:50:31 2014 +0000
@@ -34,8 +34,19 @@
 class GapAdvertisingParams
 {
   public:
-    /* See Bluetooth Core Specification 4.0 (Vol. 6), Part B, Section 2.3.1 */
-    /* See Bluetooth Core Specification 4.0 (Vol. 3), Part C, Section 9.3 */
+    /**************************************************************************/
+    /*!
+        \brief
+        Encapsulates the peripheral advertising modes, which determine how
+        the device appears to other central devices in hearing range
+
+        \par
+        See the following for more information on advertising types:
+        
+        \li \c Bluetooth Core Specification 4.0 (Vol. 6), Part B, Section 2.3.1
+        \li \c Bluetooth Core Specification 4.0 (Vol. 3), Part C, Section 9.3
+    */
+    /**************************************************************************/
     enum AdvertisingType
     {
       ADV_CONNECTABLE_UNDIRECTED,       /**< Vol 3, Part C, Section 9.3.4 and Vol 6, Part B, Section 2.3.1.1 */