adaptation for book and plug demo
Fork of BLE_API by
Diff: DOXYGEN_FRONTPAGE.md
- Revision:
- 1131:692ddf04fc42
- Parent:
- 1056:ce2fb3d09929
- Child:
- 1134:d540a48f650d
--- a/DOXYGEN_FRONTPAGE.md Tue Jan 12 19:47:52 2016 +0000 +++ b/DOXYGEN_FRONTPAGE.md Wed Apr 06 19:13:46 2016 +0100 @@ -1,30 +1,31 @@ -# BLE API {#mainpage} - -The BLE module within mbed OS offers a high abstraction level for using -Bluetooth Low Energy on multiple platforms. - -This documentation describes the internal structure of the mbed -[BLE API](https://github.com/armmbed/ble). - -For getting started with BLE on mbed, check our [introduction -page](https://docs.mbed.com/docs/ble-intros/en/latest/). - -For mbed OS examples using BLE, check [this -repository](https://github.com/armmbed/ble-examples). For mbed-classic -examples, please refer to [code under mbed.org](https://developer.mbed.org/teams/Bluetooth-Low-Energy/code/). - -## Supported Services - -Currently supported reference services include: - -* [Battery](@ref BatteryService) -* [Device Firmware Update (DFU)](@ref DFUService) -* [Device Information](@ref DeviceInformationService) -* [Health Thermometer](@ref HealthThermometerService) -* [Heart Rate](@ref HeartRateService) -* [UART](@ref UARTService) -* [UriBeacon](@ref URIBeaconConfigService) -* [iBeacon](@ref iBeacon) - -The [documentation](https://docs.mbed.com/docs/ble-intros/en/latest/AdvSamples/Overview/) +# BLE API {#mainpage} + +The BLE module within mbed OS offers a high abstraction level for using +Bluetooth Low Energy on multiple platforms. + +This documentation describes the internal structure of the mbed +[BLE API](https://github.com/armmbed/ble). It was automatically generated from +specially formatted comment blocks in BLE API's source code using Doxygen (see http://www.stack.nl/~dimitri/doxygen/ for more information on Doxygen). + +For getting started with BLE on mbed, check our [introduction +page](https://docs.mbed.com/docs/ble-intros/en/latest/). + +For mbed OS examples using BLE, check [this +repository](https://github.com/armmbed/ble-examples). For mbed-classic +examples, please refer to [code under mbed.org](https://developer.mbed.org/teams/Bluetooth-Low-Energy/code/). + +## Supported Services + +Currently supported reference services include: + +* [Battery](@ref BatteryService) +* [Device Firmware Update (DFU)](@ref DFUService) +* [Device Information](@ref DeviceInformationService) +* [Health Thermometer](@ref HealthThermometerService) +* [Heart Rate](@ref HeartRateService) +* [UART](@ref UARTService) +* [UriBeacon](@ref URIBeaconConfigService) +* [iBeacon](@ref iBeacon) + +The [documentation](https://docs.mbed.com/docs/ble-intros/en/latest/AdvSamples/Overview/) contains an overview on how to create new, application-specific services. \ No newline at end of file