mirror
/
esp-idf
kopia lustrzana https://github.com/espressif/esp-idf
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność
esp-idf/docs/api/bluetooth/esp_bt_defs.rst

66 wiersze
1.1 KiB
ReStructuredText
Czysty Zwykły widok Historia

component/bt : doxygen can generate html correctly
2016-12-01 12:20:22 +00:00
BT GENERIC DEFINES
==================
Overview
--------
`Instructions`_
Application Example
-------------------
`Instructions`_
Updated links to examples in new folders / categories in api documentation
2017-01-16 22:08:36 +00:00
.. _Instructions: ../template.html
component/bt : doxygen can generate html correctly
2016-12-01 12:20:22 +00: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 08:16:06 +00:00
* :component_file:`bt/bluedroid/api/include/esp_bt_defs.h`
component/bt : doxygen can generate html correctly
2016-12-01 12:20:22 +00:00
Macros
^^^^^^
component/bt:move the btdm_rebase_ssp_api branch to this branch
2017-04-13 14:14:28 +00:00
.. doxygendefine:: ESP_BT_OCTET16_LEN
.. doxygendefine:: ESP_BT_OCTET8_LEN
component/bt : doxygen can generate html correctly
2016-12-01 12:20:22 +00:00
.. doxygendefine:: ESP_DEFAULT_GATT_IF
.. doxygendefine:: ESP_BLE_CONN_PARAM_UNDEF
.. doxygendefine:: ESP_BLE_IS_VALID_PARAM
.. doxygendefine:: ESP_UUID_LEN_16
.. doxygendefine:: ESP_UUID_LEN_32
.. doxygendefine:: ESP_UUID_LEN_128
.. doxygendefine:: ESP_BD_ADDR_LEN
.. doxygendefine:: ESP_APP_ID_MIN
.. doxygendefine:: ESP_APP_ID_MAX
component/bt:move the btdm_rebase_ssp_api branch to this branch
2017-04-13 14:14:28 +00:00
.. doxygendefine:: ESP_BD_ADDR_STR
.. doxygendefine:: ESP_BD_ADDR_HEX
component/bt : doxygen can generate html correctly
2016-12-01 12:20:22 +00:00
Type Definitions
^^^^^^^^^^^^^^^^
component/bt:move the btdm_rebase_ssp_api branch to this branch
2017-04-13 14:14:28 +00:00
.. doxygentypedef:: esp_bt_octet16_t
.. doxygentypedef:: esp_bt_octet8_t
component/bt : doxygen can generate html correctly
2016-12-01 12:20:22 +00:00
.. doxygentypedef:: esp_bd_addr_t
Enumerations
^^^^^^^^^^^^
.. doxygenenum:: esp_bt_status_t
.. doxygenenum:: esp_bt_dev_type_t
.. doxygenenum:: esp_bd_addr_type_t
.. doxygenenum:: esp_ble_addr_type_t
Structures
^^^^^^^^^^
Functions
^^^^^^^^^