Skip to content

Commit 6d59a40

Browse files
rugeGerritsenjoerchan
authored andcommitted
bluetooth: controller: Changelog to use :cpp:func: for func references
This will improve the formatting of the documentation Signed-off-by: Rubin Gerritsen <[email protected]>
1 parent 4d29ecc commit 6d59a40

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

ble_controller/CHANGELOG.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Added
1515
Bugfixes
1616
========
1717

18-
* Fixed an issue where ``hci_data_get()`` could return "No data available" when there was data available.
18+
* Fixed an issue where :cpp:func:`hci_data_get()` could return "No data available" when there was data available.
1919
This issue would only occur when connected to multiple devices at the same time.
2020

2121
ble_controller 0.3.0-2.prealpha
@@ -33,7 +33,7 @@ Added
3333
=====
3434

3535
* Increased the number of supported SoC and library combinations.
36-
* Added API for estimating the dynamic memory usage returned by ``ble_controller_cfg_set()``.
36+
* Added API for estimating the dynamic memory usage returned by :cpp:func:`ble_controller_cfg_set()`.
3737
* Added a new header :file:`ble_controller_hci_vs.h` that exposes definitions of
3838
Vendor Specific HCI commands and events.
3939
* Added support for connection intervals less than the standard minimum of 7.5 ms.
@@ -100,10 +100,10 @@ Added
100100
=====
101101

102102
* Added API for fetching build revision information
103-
* Added ``ble_controller_rand_vector_get_blocking()``
103+
* Added :cpp:func:`ble_controller_rand_vector_get_blocking()`
104104
as a blocking call to get a vector of random bytes.
105-
* Added API to get BLE controller build revision: ``ble_controller_build_revision_get()``
106-
* Added separate ``ble_controller_init()`` API.
105+
* Added API to get BLE controller build revision: :cpp:func:`ble_controller_build_revision_get()`
106+
* Added separate :cpp:func:`ble_controller_init()` API.
107107

108108
Bugfixes
109109
========
@@ -112,10 +112,10 @@ Bugfixes
112112

113113
Changes
114114
=======
115-
* Moved ``fault_handler`` and ``p_clk_cfg`` from ``ble_controller_enable()`` to
116-
``ble_controller_init()``.
117-
* Changed ``ble_controller_process_SWI5_IRQ()`` to be IRQ independent. The
118-
generic ``ble_controller_low_prio_tasks_process()`` is used instead and SWI5
115+
* Moved ``fault_handler`` and ``p_clk_cfg`` from :cpp:func:`ble_controller_enable()` to
116+
:cpp:func:`ble_controller_init()`.
117+
* Changed :cpp:func:`ble_controller_process_SWI5_IRQ()` to be IRQ independent. The
118+
generic :cpp:func:`ble_controller_low_prio_tasks_process()` is used instead and SWI5
119119
is no longer reserved.
120120
* Aligned naming for ble_controller configuration names.
121121
* Made minor changes to existing API.

0 commit comments

Comments
 (0)