zephyr
/
esp-idf
mirror of https://github.com/zephyrproject-rtos/esp-idf.git
1
0
Fork 0
Code Issues Releases Wiki Activity
esp-idf/docs/api-reference/bluetooth/esp_bt_main.rst

53 lines
655 B
ReStructuredText
Raw Normal View History

component/bt : doxygen can generate html correctly
2016-12-01 13:20:22 +01:00
BT MAIN API
===========
Overview
--------
`Instructions`_
Application Example
-------------------
`Instructions`_
Updated links to examples in new folders / categories in api documentation
2017-01-16 23:08:36 +01:00
.. _Instructions: ../template.html
component/bt : doxygen can generate html correctly
2016-12-01 13:20:22 +01:00
API Reference
-------------
Header Files
^^^^^^^^^^^^
docs: use custom roles to generate GitHub links This change replaces direct links to GitHub master branch with auto-generated links using docutils custom roles. These auto-generated links point to the tree or blob for the git commit ID (or tag) of the repository. This is needed to ensure that links don’t become broken when files in master branch are moved around or deleted. The following roles are introduced: - :idf:`path` - points to directory inside ESP-IDF - :idf_blob:`path` - points to file inside ESP-IDF - :idf_raw:`path` - points to raw view of the file inside ESP-IDF - :component:`path` - points to directory inside ESP-IDF components dir - :component_blob:`path` - points to file inside ESP-IDF components dir - :component_raw:`path` - points to raw view of the file inside ESP-IDF components dir - :example:`path` - points to directory inside ESP-IDF examples dir - :example_blob:`path` - points to file inside ESP-IDF examples dir - :example_raw:`path` - points to raw view of the file inside ESP-IDF examples dir A check is added to the CI build script, which searches RST files for presence of hard-coded links (identified by tree/master, blob/master, or raw/master part of the URL). This check can be run manually: cd docs && make gh-linkcheck Additionally, Sphinx linkcheck build type is used to create new CI test, which check for broken links. This test has to be triggered explicitly, because including it in normal build process (when the commit is not yet deployed to Github) will not work. It can be triggered in a regular fashion using a combination of cron and Curl, similar to stress tests.
2017-01-19 09:16:06 +01:00
* :component_file:`bt/bluedroid/api/include/esp_bt_main.h`
component/bt : doxygen can generate html correctly
2016-12-01 13:20:22 +01:00
Macros
^^^^^^
Type Definitions
^^^^^^^^^^^^^^^^
Enumerations
^^^^^^^^^^^^
component/bt: bug fix of lack of checking bluetooth stack status inside API functions
2017-01-11 04:04:41 +01:00
.. doxygenenum:: esp_bluedroid_status_t
component/bt : doxygen can generate html correctly
2016-12-01 13:20:22 +01:00
Structures
^^^^^^^^^^
Functions
^^^^^^^^^
component/bt: bug fix of lack of checking bluetooth stack status inside API functions
2017-01-11 04:04:41 +01:00
.. doxygenfunction:: esp_bluedroid_get_status
component/bt: modify bluetooth API 1. VHCI api and doxygen 2. Controller api and doxygen 3. bluedroid init/enable api and doxygen 4. cleanup demo codes
2017-01-03 08:53:06 +01:00
.. doxygenfunction:: esp_bluedroid_enable
.. doxygenfunction:: esp_bluedroid_disable
.. doxygenfunction:: esp_bluedroid_init
.. doxygenfunction:: esp_bluedroid_deinit
component/bt : doxygen can generate html correctly
2016-12-01 13:20:22 +01:00