Commit Graph

88 Commits (81dbd035ab37e9601d44ff0cd5b6f540efbe2b02)

Author SHA1 Message Date
Martin Kojtal 81dbd035ab
Merge pull request #5392 from pan-/improve-ble-docs
Improve ble docs
2017-11-16 16:21:50 +00:00
Martin Kojtal b76b3f723d
Merge pull request #5472 from pan-/doc_battery_service
BLE: Update BatteryService documentation.
2017-11-16 16:17:50 +00:00
Amanda Butler a855251cba
Copy edit HeartRateService.h
Make minor copy edits.
2017-11-13 04:12:03 -06:00
Vincent Coubard 93a4a2a87b BLE: update heart rate service definition.
This patch includes:
* Documentation update.
* Code simplification and correctness; the value overloads based on the
  size of the hrm counter has been removed in favor of runtime check which
  is more correct.
* The control point characteristic has been removed since HeartRate value
  byte does not support the accumulated energy expanded.
2017-11-10 15:38:39 +00:00
Vincent Coubard 220652ffac BLE: Fix assertion in Battery service. 2017-11-10 11:02:48 +00:00
Amanda Butler 521345307b
Copy edit BatteryService.h
Make minor copy edits, mostly for active voice and U.S. spelling.
2017-11-09 12:39:18 -06:00
Vincent Coubard 423cd23ec0 BLE: Update BatteryService documentation. 2017-11-09 18:08:32 +00:00
Martin Kojtal 82f5b58f4c
Merge pull request #5295 from pan-/GAP-platform-abstraction-layer
BLE: Gap platform abstraction layer
2017-11-09 16:54:11 +00:00
Amanda Butler 3dc28ce01b
Copy edit GattCharacteristic.h
Copy edit file.
2017-11-08 15:09:00 -06:00
Amanda Butler bdf0cbb3c9
Copy edit GapAdvertisingData.h
Copy edit file.
2017-11-08 14:58:38 -06:00
Amanda Butler 6f7f5ae57e
Copy edit GattClient.h
Make copy edits to file.
2017-11-08 14:14:04 -06:00
Amanda Butler 3a80f8b823
Copy edit Gap.h
Copy edit file.
2017-11-08 11:32:31 -06:00
Amanda Butler 6e20887724
Copy edit GattServer.h
Copy edit, mostly for consistent tense and hyphenation.
2017-11-07 17:56:44 -06:00
Amanda Butler 5178f89c8b
Copy edit GattCallbackParamTypes.h
Copy edit for active voice.
2017-11-07 17:42:40 -06:00
Amanda Butler 91fa78d980
Copy edit GapScanningParams.h
Copy edit, mostly for consistent tense across documents.
2017-11-07 17:33:16 -06:00
Amanda Butler 9052cf45c3
Copy edit GattAttribute.h
Make minor copy edits for active voice and phrasing.
2017-11-07 17:27:41 -06:00
Amanda Butler fcb50dd5c8
Copy edit ServiceDiscovery.h
Make minor copy edits, mostly for consistent tense.
2017-11-07 17:24:17 -06:00
Amanda Butler 1720a484dd
Copy edit UUID.h
Copy edit, mostly for consistent tense and consistent use of hyphens.
2017-11-07 17:00:34 -06:00
Amanda Butler 71bc3f74da
Copy edit blecommon.h
Copy edit, mostly for consistent punctuation.
2017-11-07 16:33:49 -06:00
Amanda Butler 4702ff2070
Copy edit GapAdvertisingParams.h
Make minor copy edits, mostly for active voice and comma use.
2017-11-07 16:31:09 -06:00
Amanda Butler 6e455417d3
Copy edit SafeBool.h
Make minor copy edits, mostly for nonrestrictive clauses.
2017-11-07 16:25:45 -06:00
Amanda Butler 739b59b598
Copy edit GattService.h
Change passive to active voice.
2017-11-07 16:20:36 -06:00
Amanda Butler 69a06a9f52
Copy edit GattServerEvents.h
Make minor copy edits for active voice, brevity and comma use.
2017-11-07 16:18:23 -06:00
Amanda Butler bd39a6eb75
Copy edit FunctionPointerWithContext.h
Make minor copy edits, mostly for consistent tense across documentation.
2017-11-07 16:10:29 -06:00
Amanda Butler 4bf95bc3f8
Copy edit DiscoveredService.h
Make minor copy edits, mostly for active voice and branding.
2017-11-07 15:59:37 -06:00
Amanda Butler 7a4ac93eb1
Copy edit DiscoveredCharacteristicDescriptor.h
Copy edit, mostly for active voice.
2017-11-07 15:56:05 -06:00
Amanda Butler 08ba159cf6
Copy edit DiscoveredCharacteristic.h
Make minor copy edits, mostly for active voice and American English.
2017-11-07 15:52:43 -06:00
Amanda Butler c9931f3643
Copy edit CharacteristicDescriptorDiscovery.h
Make minor copy edits, mostly for active voice.
2017-11-07 15:34:57 -06:00
Amanda Butler 0f91ea2b2a
Copy edit CallChainOfFunctionPointersWithContext.h
Make minor copy edits, mostly for typos.
2017-11-07 15:30:27 -06:00
Vincent Coubard 3cbe3918e7 BLE: Update BLE.h comments.
* processEvents: Remove reference to mbed OS 3.
* Clarify documentation of waitForEvent.
2017-11-06 14:37:58 +00:00
Jimmy Brisson a9b594b428
Merge pull request #5410 from pan-/deprecate-gap-events
BLE: Deprecate GapEvent
2017-11-02 10:44:15 -05:00
Vincent Coubard 744abca8ff BLE: Adaptation interface of the GAP layer.
This interface expose the primitives needed to realize operations defined in
the GAP layer. Data types, event and function definitions follow closely HCI
commands and events defined in the Bluetooth specification.
2017-10-31 17:32:01 +00:00
Vincent Coubard 3ad3942810
BLE: Fix typos in iBeacon documentation. 2017-10-31 16:50:07 +00:00
Vincent Coubard 65bb642c81 BLE: Deprecate GapEvent
This class and its components are not used by BLE API and never been used in the
last two years.

This patch deprecate all the components in GapEvent.h and exclude its definitions
from the documentation process.
2017-10-31 16:39:24 +00:00
Amanda Butler 0042cd8751
Copy edit iBeacon.h
Make minor copy edits.
2017-10-31 11:27:23 -05:00
Vincent Coubard 5d26ea50f3 BLE: Fix conjugation and spelling of iBeacon documentation. 2017-10-31 13:19:16 +00:00
Vincent Coubard 699ad9c29c BLE: iBeacon minor edit. 2017-10-31 11:55:31 +00:00
Vincent Coubard 62e984bdb3 BLE: Update iBeacon documentation.
Provide detailled description of the purpose, general concepts and usage.
2017-10-31 11:43:16 +00:00
Amanda Butler 25ad0f3959
Copy edit BLEInstanceBase.h
Make minor copy edits.
2017-10-30 17:26:48 -05:00
Amanda Butler 96429c5212
Copy edit BLE.h
Make minor copy edits, mostly for active voice and consistent comma use across docs.
2017-10-30 14:26:55 -05:00
Amanda Butler 2038e72782
Copy edit ArrayView.h
Copy edit, mostly for active voice and agreement.
2017-10-30 11:03:15 -05:00
Vincent Coubard 3c3592a9d3 BLE: Update documentation.
Fix typos, spelling and conjugation.
2017-10-30 15:40:58 +00:00
Vincent Coubard 67b47cad87 BLE: Group GattServer documented elements 2017-10-27 14:37:57 -05:00
Vincent Coubard 1c2685c2ac BLE: Improve GattClient.h documentation. 2017-10-27 14:37:02 -05:00
Vincent Coubard 075e1dbdd9 BLE: Improve Gap.h documentation. 2017-10-27 14:35:51 -05:00
Vincent Coubard e4a097f4ee BLE: Imrpove deprecated.h documentation. 2017-10-27 14:34:51 -05:00
Vincent Coubard 7f22d25018 BLE: Improve GattServerEvents.h documentation. 2017-10-27 14:33:54 -05:00
Vincent Coubard a7b4d6accd BLE: Improve GattCallbackParamTypes.h documentation. 2017-10-27 14:32:53 -05:00
Vincent Coubard e3252da515 BLE: Improve ServiceDiscovery.h documentation. 2017-10-27 14:31:43 -05:00
Vincent Coubard a03192f625 BLE: Improve UUID.h documentation. 2017-10-27 14:30:41 -05:00