OVMS3-idf/docs/api
Jiang Jiang Jian bd20288b81 Merge branch 'feature/btdm_bluedroid' into 'master'
Feature/btdm bluedroid

This branch contain the bluedroid host code.
Currently,  Only GAP/GATT SERVER/GATT CLIENT release to users.
Actually, the content of the codes is further more than GAP/GATT and etc.
In this release version, users only need to concern about the APIs which are in "api/include/".

Now, suggestions in comment have been resolved are following:
1. The APIs use callback function. Ivan , Jeroen and me have discussed it. Currently the code will not be changed.
2. The APIs use OPEN/CLOSE. I have ask Ivan, besides bluedroid do this, we will keep the name.
3. Coding style. I have run format.sh to handle the style. And some spell error have been fixed.
4. APIs doxygen. I have clean the warning by doxygen. But bt.rst is still need to be completed.
5. Other comment without resolved face to face that I have to add response in the comment and fix them in the code
6. Fix some incorrect things. See the git log for details.

This 1st version of bluedroid release still have lots of things to do. But it can be done after this merge.
1. Compelete the BLUFI(Bluetooth config wifi connection) documents, security, application protocol and other.
2. Add SPP-LIKE profile.
3. Do more examples codes to cover most of the APIs.
4. Test and fix bug.

Another thing:
1. Do the document of APIs.(xml->bt.rst->html) 
(I will do this before merge as Ivan's suggestion)
This is already done. Besides, the union type in doxygen have something error. Ivan will fix it.



See merge request !239
2016-12-02 12:07:20 +08:00
..
bt.rst component/bt : doxygen can generate html correctly 2016-12-01 20:20:22 +08:00
bt_common.rst component/bt : doxygen can generate html correctly 2016-12-01 20:20:22 +08:00
bt_le.rst component/bt : doxygen can generate html correctly 2016-12-01 20:20:22 +08:00
esp_bt_defs.rst component/bt : doxygen can generate html correctly 2016-12-01 20:20:22 +08:00
esp_bt_main.rst component/bt : doxygen can generate html correctly 2016-12-01 20:20:22 +08:00
esp_eth.rst ethernet: add first version of ethernet driver 2016-12-01 19:17:48 +08:00
esp_gap_ble.rst component/bt : doxygen can generate html correctly 2016-12-01 20:20:22 +08:00
esp_gatt_defs.rst component/bt : doxygen can generate html correctly 2016-12-01 20:20:22 +08:00
esp_gattc.rst component/bt : doxygen can generate html correctly 2016-12-01 20:20:22 +08:00
esp_gatts.rst component/bt : doxygen can generate html correctly 2016-12-01 20:20:22 +08:00
esp_wifi.rst Revised api files 2016-11-10 22:50:55 +01:00
gpio.rst Revised api files 2016-11-10 22:50:55 +01:00
ledc.rst doc: API Reference - examples & fixes 2016-11-21 10:25:11 +08:00
log.rst Revised api files 2016-11-10 22:50:55 +01:00
nvs_flash.rst doc: API Reference - examples & fixes 2016-11-21 10:25:11 +08:00
ota.rst docs: fix return error of ota docs and fix ota.rst 2016-12-01 13:54:25 +08:00
pcnt.rst driver: improve pulse counter code 2016-11-24 12:01:21 +08:00
rmt.rst rmt: add documentation 2016-11-22 01:44:23 +08:00
spi_flash.rst docs: fix broken links, formatting, add SPI flash and partition APIs 2016-11-16 22:44:22 +08:00
template.rst Revised api files 2016-11-10 22:50:55 +01:00
timer.rst driver: timer 2016-11-23 17:23:21 +08:00
uart.rst Revised api files 2016-11-10 22:50:55 +01:00
vfs.rst doc: API Reference - examples & fixes 2016-11-21 10:25:11 +08:00
vhci.rst component/bt : doxygen can generate html correctly 2016-12-01 20:20:22 +08:00
wdts.rst Add documentation 2016-11-17 12:09:08 +08:00