Added a Makefile to generate the api doc using Doxygen.
Move doc files to the doxygen folder.
This commit is contained in:
parent
6e837e3ec7
commit
62e119b5f4
3 changed files with 28 additions and 3 deletions
12
doxygen/Makefile
Normal file
12
doxygen/Makefile
Normal file
|
@ -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
|
|
@ -664,7 +664,7 @@ WARN_LOGFILE =
|
|||
# directories like "/usr/src/myproject". Separate the files or directories
|
||||
# with spaces.
|
||||
|
||||
INPUT = .
|
||||
INPUT = ../ble ../source ./
|
||||
|
||||
# This tag can be used to specify the character encoding of the source files
|
||||
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
|
||||
|
@ -682,7 +682,7 @@ INPUT_ENCODING = UTF-8
|
|||
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
|
||||
# *.f90 *.f *.for *.vhd *.vhdl
|
||||
|
||||
FILE_PATTERNS = *.h *.cpp
|
||||
FILE_PATTERNS = *.h *.cpp *.md
|
||||
|
||||
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
|
||||
# should be searched for input files as well. Possible values are YES and NO.
|
|
@ -1,4 +1,4 @@
|
|||
#BLE API
|
||||
# BLE API {#mainpage}
|
||||
|
||||
The BLE module within mbed OS offers a high abstraction level for using
|
||||
Bluetooth Low Energy on multiple platforms.
|
||||
|
@ -13,3 +13,16 @@ 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 a new issue