mirror of
https://github.com/espressif/esp-nimble.git
synced 2026-10-10 16:27:22 +00:00
documentation/sphinx: Fix formatting errors in .rst files
Fixes broken references to other documents/sections. Adds `Host Identity` to the API reference.
This commit is contained in:
committed by
Szymon Janc
parent
16e1bfc679
commit
67f7e979f0
+3
-3
@@ -1,5 +1,5 @@
|
|||||||
NimBLE Bluetooth Stack Documentation
|
NimBLE Bluetooth Stack Documentation
|
||||||
#################################
|
####################################
|
||||||
|
|
||||||
This folder holds the documentation for the NimBLE Bluetooth stack from the
|
This folder holds the documentation for the NimBLE Bluetooth stack from the
|
||||||
`Apache Mynewt`_ project. It is built using `Sphinx`_.
|
`Apache Mynewt`_ project. It is built using `Sphinx`_.
|
||||||
@@ -19,8 +19,8 @@ Previewing Changes
|
|||||||
==========================
|
==========================
|
||||||
|
|
||||||
In order to preview any changes you make you must first install a Sphinx
|
In order to preview any changes you make you must first install a Sphinx
|
||||||
toolchain as described at https://github.com/apache/mynewt-documentation#id3.
|
toolchain as described at https://github.com/apache/mynewt-documentation.
|
||||||
Then:
|
Then:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
|
|||||||
@@ -43,3 +43,10 @@ Header
|
|||||||
.. code-block:: cpp
|
.. code-block:: cpp
|
||||||
|
|
||||||
#include "host/ble_hs.h"
|
#include "host/ble_hs.h"
|
||||||
|
|
||||||
|
API
|
||||||
|
~~~
|
||||||
|
|
||||||
|
.. doxygengroup:: bt_host_id
|
||||||
|
:content-only:
|
||||||
|
:members:
|
||||||
|
|||||||
@@ -52,12 +52,12 @@ Method 3: Configure a random address at runtime
|
|||||||
Random addresses get configured through the NimBLE host. The following
|
Random addresses get configured through the NimBLE host. The following
|
||||||
two functions are used in random address configuration:
|
two functions are used in random address configuration:
|
||||||
|
|
||||||
- :doc:`ble_hs_id_gen_rnd <../ble_hs/ble_hs_id/functions/ble_hs_id_gen_rnd>`:
|
- :c:func:`ble_hs_id_gen_rnd`:
|
||||||
Generates a new random address.
|
Generates a new random address.
|
||||||
- :doc:`ble_hs_id_set_rnd <../ble_hs/ble_hs_id/functions/ble_hs_id_set_rnd>`:
|
- :c:func:`ble_hs_id_set_rnd`:
|
||||||
Sets the device's random address.
|
Sets the device's random address.
|
||||||
|
|
||||||
For an example of how this is done, see the :doc:`<../../../os/tutorials/ibeacon>`.
|
For an example of how this is done, see the :doc:`../../../tutorials/ble/ibeacon`.
|
||||||
|
|
||||||
*Note:* A NimBLE device can be configured with multiple addresses; at
|
*Note:* A NimBLE device can be configured with multiple addresses; at
|
||||||
most one of each address type.
|
most one of each address type.
|
||||||
|
|||||||
@@ -411,7 +411,7 @@ Advertising with Extended Advertising enabled
|
|||||||
+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
|
+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
|
||||||
| | scan\_req\_notif | [``0``-1] | Enable SCAN\_REQ notifications |
|
| | scan\_req\_notif | [``0``-1] | Enable SCAN\_REQ notifications |
|
||||||
+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
|
+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
|
||||||
| **advertise-set-addr** | | | Configure *random* address for instance |
|
| **advertise-set-addr** | | | Configure *random* address for instance |
|
||||||
+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
|
+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
|
||||||
| | instance | [``0``-UINT8\_MAX] | Advertising instance |
|
| | instance | [``0``-UINT8\_MAX] | Advertising instance |
|
||||||
+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
|
+------------------------------+--------------------------+----------------------------+-------------------------------------------------------------------------------------+
|
||||||
|
|||||||
Reference in New Issue
Block a user