Fix documentation of BLE GattCharacteristic

akosthekiss · akosthekiss · commit 87a2b5bd6f45 · 2017-10-05T11:15:30.000+02:00
The constructor doc incorrectly suggested that only short (16-bit)
UUIDs were accepted. The same doc also referred to properties
instead of characteristics. (And to "value length", which seemed to
be completely out of place in the context of the current code.)
diff --git a/features/FEATURE_BLE/ble/GattService.h b/features/FEATURE_BLE/ble/GattService.h
@@ -46,8 +46,7 @@ class GattService {
 
 public:
     /**
-     *  @brief  Creates a new GattService using the specified 16-bit
-     *          UUID, value length, and properties.
+     *  @brief  Creates a new GattService using the specified UUID and characteristics.
      *
      *  @note   The UUID value must be unique and is normally >1.
      *

Original file line number	Diff line number	Diff line change
`@@ -46,8 +46,7 @@ class GattService {`
`46`	`46`
`47`	`47`	`public:`
`48`	`48`	`/**`
`49`		`- * @brief Creates a new GattService using the specified 16-bit`
`50`		`- * UUID, value length, and properties.`
	`49`	`+ * @brief Creates a new GattService using the specified UUID and characteristics.`
`51`	`50`	`*`
`52`	`51`	`* @note The UUID value must be unique and is normally >1.`
`53`	`52`	`*`