Javier Velasco / 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.

Dependents:   BLE_iBeacon

Fork of BLE_API by Bluetooth Low Energy

Diff: ble/blecommon.h

Revision:
986:5292837107a3
Parent:
979:afca129bf85f
Child:
990:53ac0ac3aa39
--- a/ble/blecommon.h	Thu Nov 26 12:52:37 2015 +0000
+++ b/ble/blecommon.h	Thu Nov 26 14:51:21 2015 +0000
@@ -22,7 +22,9 @@
 #endif
 
 
-/*! @brief Assigned values for BLE UUIDs. */
+/** @defgroup BLE_UUID_VALUES assigned values for BLE UUIDs.
+ * @{ */
+/* Generic UUIDs, applicable to all services. */
 enum {
     BLE_UUID_UNKNOWN                             = 0x0000, /**< Reserved UUID. */
     BLE_UUID_SERVICE_PRIMARY                     = 0x2800, /**< Primary Service. */
@@ -48,10 +50,11 @@
     BLE_UUID_GAP_CHARACTERISTIC_RECONN_ADDR      = 0x2A03, /**< Reconnection Address Characteristic. */
     BLE_UUID_GAP_CHARACTERISTIC_PPCP             = 0x2A04, /**< Peripheral Preferred Connection Parameters Characteristic. */
 };
+/** @} */
 
-/*! Bluetooth appearance values.
+/** @defgroup BLE_APPEARANCES Bluetooth appearance values.
  *  @note Retrieved from http://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.gap.appearance.xml
- */
+ * @{ */
 enum {
     BLE_APPEARANCE_UNKNOWN                             =    0, /**< Unknown. */
     BLE_APPEARANCE_GENERIC_PHONE                       =   64, /**< Generic Phone. */
@@ -103,9 +106,13 @@
     BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_POD          = 5187, /**< Location Pod (Outdoor Sports Activity subtype). */
     BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_AND_NAV_POD  = 5188, /**< Location and Navigation Pod (Outdoor Sports Activity subtype). */
 };
-
+/** @} */
 
-/*! @brief Error codes for the BLE API. */
+/**************************************************************************/
+/*!
+    \brief  Error codes for the BLE API
+*/
+/**************************************************************************/
 enum ble_error_t {
     BLE_ERROR_NONE                      = 0, /**< No error. */
     BLE_ERROR_BUFFER_OVERFLOW           = 1, /**< The requested action would cause a buffer overflow and has been aborted. */