Merge branch 'doxygen' of https://github.com/metc/ble into metc-doxygen
commit
6adaa03ed7
@ -1,7 +1,7 @@
|
||||
# Hello!
|
||||
We are an open source project of [ARM mbed](https://www.mbed.com). Contributions via [pull request](https://github.com/ARMmbed/ble/pulls), and [bug reports](https://github.com/ARMmbed/ble/issues) are welcome!
|
||||
|
||||
Please submit your pull request to the 'develop' branch of this module. Commits to develop will merge into master at the time of the next release.
|
||||
Please submit your pull request to the `develop` branch of [this module](https://github.com/ARMmbed/ble/tree/develop). Commits to develop will be merge into the master branch at the time of the next release.
|
||||
|
||||
# Contributor agreement
|
||||
For your pull request to be accepted, we will need you to agree to our [contributor agreement](https://developer.mbed.org/contributor_agreement/) to give us the necessary rights to use and distribute your contributions. (To click through the agreement create an account on mbed.com and log in.)
|
||||
|
@ -1,16 +0,0 @@
|
||||
#BLE API
|
||||
|
||||
The BLE module within mbed OS offers a high level abstraction for using
|
||||
Bluetooth Low Energy on multiple platforms.
|
||||
|
||||
This documentation describes the internal structure of 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, refer to (code under mbed.org)[https://developer.mbed.org/teams/Bluetooth-Low-Energy/code/].
|
@ -0,0 +1,2 @@
|
||||
# Ignore the generated Doxygen output
|
||||
/apidoc/
|
@ -0,0 +1,12 @@
|
||||
# Makefile used to generate the API documentation using Doxygen
|
||||
|
||||
.PHONY: apidoc apidoc_clean
|
||||
|
||||
all: apidoc
|
||||
|
||||
apidoc:
|
||||
mkdir -p apidoc
|
||||
doxygen ble.doxyfile
|
||||
|
||||
apidoc_clean:
|
||||
rm -rf apidoc
|
@ -0,0 +1,28 @@
|
||||
# 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 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)
|
Loading…
Reference in new issue