Commit graph

28 commits

Author SHA1 Message Date
Wu Jian Gang 667d0ef319 docs: fix example index 2016-12-02 16:02:20 +08:00
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
Tian Hao df419fd862 component/bt : doxygen can generate html correctly 2016-12-01 20:20:22 +08:00
shangke e0040af7e5 ethernet: add first version of ethernet driver 2016-12-01 19:17:48 +08:00
tzx 9b2cad4174 docs: fix return error of ota docs and fix ota.rst 2016-12-01 13:54:25 +08:00
Tian Zhong Xing 72422b32dc feature/fota_ops_api: add ota core api implement 2016-11-28 17:12:57 +08:00
Wangjialin a5ad8090cf Merge branch 'master' into driver_merge_tmp/merge_timer
# Conflicts:
#	docs/index.rst
2016-11-25 01:07:19 +08:00
Wangjialin f97f198c9d driver: improve pulse counter code
1. Modify some comments in pcnt.h
2. Modify api/pcnt.rst
3. Improve example code.
4. Add status definitions in pcnt_reg.h
2016-11-24 12:01:21 +08:00
Wangjialin a97e076dec add pcnt.rst 2016-11-23 19:07:30 +08:00
Wangjialin 6db1482cd5 Merge branch 'master' into driver_merge_tmp/merge_pcnt
# Conflicts:
#	components/driver/include/driver/periph_ctrl.h
2016-11-23 18:15:54 +08:00
Wangjialin 7571b8c2e4 driver: PCNT
minor changes
2016-11-23 18:10:45 +08:00
Wangjialin c533099e08 driver: timer
1. minor modifications
2. use TIMG_WDT_INT_ENA_M instead of BIT(2) in wdt.c
3. add doc/api/timer.rst
2016-11-23 17:23:21 +08:00
Ivan Grokhotkov 383d987697 Merge branch 'doc/pr103_cleanup' into 'master'
Documentation cleanup

From @kryzchb, github pull request #103

See merge request !214
2016-11-22 13:26:56 +08:00
Wangjialin 235eceea06 rmt: add documentation 2016-11-22 01:44:23 +08:00
Krzysztof bf61f6de55 doc: API Reference - examples & fixes 2016-11-21 10:25:11 +08:00
Jeroen Domburg f3a44aa4db Merge with master; merge Doxygen config 2016-11-17 20:21:12 +08:00
Jeroen Domburg d116adf260 Add documentation 2016-11-17 12:09:08 +08:00
Ivan Grokhotkov ca202cbb46 docs: fix broken links, formatting, add SPI flash and partition APIs 2016-11-16 22:44:22 +08:00
Krzysztof ce0382f0c0 Revised api files
- Included UART API
- Addedd "Header Files"
- Improved template
- deleted redundat nvs.rst
2016-11-10 22:50:55 +01:00
Krzysztof c3f7d15246 Instructions to prepare documentation 2016-11-05 17:19:31 +01:00
Krzysztof 3eaf1ec907 All API Reference docs updated to match header files
1. Wi-Fi <api/esp_wifi>
2. Bluetooth <api/bt>
2. GPIO <api/gpio>
4. LED
Control <api/ledc>
5. Logging <api/log>
6. Non-Volatile Storage
<api/nvs_flash>
7. Virtual Filesystem <api/vfs>
2016-11-05 17:18:25 +01:00
Krzysztof 079f5faad8 Fixed confused Sphinx
Sphinx failed to phrase esp_log_timestamp
reorderdering esp_log_write and esp_log_timestamp fixed this issue
2016-11-01 01:21:18 +08:00
Krzysztof 905d27815c API samples
- Logging library
- Virtual file system component
2016-11-01 01:21:18 +08:00
Krzysztof 234739f51a Draft of non-volatile storage component documentation 2016-11-01 01:20:04 +08:00
Krzysztof f05cd619f4 Sample cleaning of markup 2016-11-01 01:20:04 +08:00
Krzysztof adae42fd85 API template
- reflected template in other DRAFT API dcouments
- DRAFT of Bluetooth API
- link fixes in CONTRIBUTING.rst
2016-11-01 01:20:04 +08:00
krzychb b6a463e94f Draft of GPIO API included 2016-11-01 01:20:04 +08:00
Krzysztof 8ae97a2855 Initial list of Wi-Fi API 2016-11-01 01:20:04 +08:00