Skip to content

Commit 12c304d

Browse files
committed
doc: Documentation check for 2.9
Documentation check and fixes for 2.9 release Signed-off-by: Uma Praseeda <[email protected]>
1 parent 7f23024 commit 12c304d

File tree

5 files changed

+17
-17
lines changed

5 files changed

+17
-17
lines changed

mpsl/doc/cx.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Short-Range Protocols External Radio Coexistence
88
:depth: 2
99

1010
The radio coexistence feature allows the application to interface with several types of packet traffic arbiters (PTAs).
11-
PTAs arbitrate the requested radio operations between all radios to avoid interference, providing better radio performance to devices using multiple interfering radios simultaneously, like a combination of IEEE 802.15.4, Bluetooth® Low Energy (LE), and Wi-Fi.
11+
PTAs arbitrate the requested radio operations between all radios to avoid interference, providing better radio performance to devices using multiple interfering radios simultaneously, like a combination of IEEE 802.15.4, Bluetooth® Low Energy (LE), and Wi-Fi®.
1212
The arbitration algorithm used can vary between PTAs.
1313

1414
.. note::
@@ -17,7 +17,7 @@ The arbitration algorithm used can vary between PTAs.
1717
Overview
1818
********
1919

20-
The radio coexistence feature allows short-range protocol drivers (e.g. IEEE 802.15.4, Bluetooth LE) to communicate with the packet traffic arbiter (PTA) using :ref:`MPSL CX API <mpsl_api_sr_cx>`.
20+
The radio coexistence feature allows short-range protocol drivers (for example, IEEE 802.15.4, Bluetooth LE) to communicate with the packet traffic arbiter (PTA) using :ref:`MPSL CX API <mpsl_api_sr_cx>`.
2121
The MPSL CX API is hardware-agnostic and separates the implementation of the protocol driver from an implementation specific to given PTA.
2222
To perform any radio operation, the protocol drivers must first request the appropriate access to the medium from the PTA.
2323
The request informs the PTA implementation about which radio operations it wants to perform at that moment or shortly after, and what is the priority of the operation.
@@ -36,7 +36,7 @@ Selecting CX Implementation
3636

3737
The :ref:`mpsl` itself does not provide any implementation of the CX interface.
3838
For details on the implementations present in the |NCS|, see :ref:`nrf:ug_radio_coex`.
39-
An application that needs to use CX must call :c:func:`mpsl_cx_interface_set()` during the system initialization.
39+
An application that needs to use CX must call :c:func:`mpsl_cx_interface_set` during the system initialization.
4040
The initialization of any resource needed by the selected CX implementation is not in scope of :ref:`mpsl` and must also be done during the system initialization.
4141

4242
.. note::

nfc/CHANGELOG.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ nRF Connect SDK v2.6.0
2323
Added
2424
=====
2525

26-
* Added functions :c:func:`nfc_platform_buffer_alloc()` and :c:func:`nfc_platform_buffer_free()` for the platform layer.
26+
* Added functions :c:func:`nfc_platform_buffer_alloc` and :c:func:`nfc_platform_buffer_free` for the platform layer.
2727
The NFCT buffer for data exchange is now outside the library implementation.
2828
You have to define these two functions and return a memory that is accessible by the EasyDMA utility.
2929
* A possibility to modify the maximum value for the Frame Wait time Integer by using the ``NFC_T4T_PARAM_FWI_MAX`` parameter.
3030

3131
Modified
3232
========
3333

34-
* The :c:func:`nfc_platform_setup()` function now provides a pointer to the interrupt priority of the NFCT peripheral.
34+
* The :c:func:`nfc_platform_setup` function now provides a pointer to the interrupt priority of the NFCT peripheral.
3535
Its value must be set to the requested one.
3636
In implementations where the operating system is responsible for setting the interrupt priority, this value is not relevant.
3737

@@ -41,14 +41,14 @@ nRF Connect SDK v2.3.0
4141
Added
4242
=====
4343

44-
* A callback requested by the :c:func:`nfc_platform_cb_request()` function to allow execution of platform-dependent code before executing the user callback.
44+
* A callback requested by the :c:func:`nfc_platform_cb_request` function to allow execution of platform-dependent code before executing the user callback.
4545
* A header file :file:`nfc_platform.h` for platform layer.
4646

4747
Modified
4848
========
4949

50-
* The :c:func:`nfc_platform_setup()` function now provides a pointer to the callback resolution function that is used to execute the user-defined NFC callback.
51-
* The :c:func:`nfc_t2t_setup()` function was updated to allow coexistence of the Type 2 Tag and the Type 4 Tag libraries.
50+
* The :c:func:`nfc_platform_setup` function now provides a pointer to the callback resolution function that is used to execute the user-defined NFC callback.
51+
* The :c:func:`nfc_t2t_setup` function was updated to allow coexistence of the Type 2 Tag and the Type 4 Tag libraries.
5252

5353
nRF Connect SDK v2.1.0
5454
**********************
@@ -64,7 +64,7 @@ nRF Connect SDK v2.0.0
6464
Bug fixes
6565
=========
6666

67-
* Fixed the Type 2 Tag initialization, where the return value of the :c:func:`nfc_platform_nfcid1_default_bytes_get()` function was not converted to the local NFC error code resulting in incorrect NFCID1 values.
67+
* Fixed the Type 2 Tag initialization, where the return value of the :c:func:`nfc_platform_nfcid1_default_bytes_get` function was not converted to the local NFC error code resulting in incorrect NFCID1 values.
6868

6969
nRF Connect SDK v1.9.0
7070
**********************
@@ -103,7 +103,7 @@ Modified
103103

104104
* Debug info is removed from the NFC T2T and T4T libraries.
105105
* Fixed duplicated initial Frame Waiting Time (FWT) value setting.
106-
* Modified the :c:func:`nfc_t2t_done()` and the :c:func:`nfc_t4t_done()` functions to uninitialize the NFCT driver to achieve symmetry in the library behaviour since the :c:func:`nfc_txt_setup()` function initializes the NFCT driver.
106+
* Modified the :c:func:`nfc_t2t_done` and the :c:func:`nfc_t4t_done` functions to uninitialize the NFCT driver to achieve symmetry in the library behaviour since the :c:func:`nfc_txt_setup` function initializes the NFCT driver.
107107
* Fixed FSDI value setting for RFU value cases.
108108

109109
nRF Connect SDK v1.6.0

nrf_802154/doc/CHANGELOG.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ Notable Changes
287287
* The release notes of the legacy versions of the Radio Driver are available in the Changelog for 802.15.4 Radio Driver v1.10.0.
288288
* The changelog of the previous versions of the 802.15.4 SL library is now located at the bottom of this page.
289289
* The Radio Driver documentation will now also include the Service Layer documentation.
290-
* Future versions of the Radio Driver and the Service Layer will follow NCS version tags.
290+
* Future versions of the Radio Driver and the Service Layer will follow |NCS| version tags.
291291
* The 802.15.4 Radio Driver API has been modified to support more than a single delayed reception window simultaneously.
292292
The :c:func:`nrf_802154_receive_at`, :c:func:`nrf_802154_receive_at_cancel`, and :c:func:`nrf_802154_receive_failed` functions take an additional parameter that identifies a given reception window unambiguously.
293293

nrf_modem/doc/CHANGELOG.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ nrf_modem
1515
Sockets
1616
=======
1717

18-
* Updated the :c:func:`nrf_send()` and :c:func:`nrf_sendto()` functions to correctly set ``errno`` when the socket is closed during a send operation with :c:macro:`NRF_MSG_WAITACK`.
18+
* Updated the :c:func:`nrf_send` and :c:func:`nrf_sendto` functions to correctly set ``errno`` when the socket is closed during a send operation with :c:macro:`NRF_MSG_WAITACK`.
1919

2020
DECT NR+
2121
========
@@ -337,7 +337,7 @@ Bootloader
337337
nrf_modem 2.2.1
338338
***************
339339

340-
* Added the ``MODEM_DFU_RESULT_VOLTAGE_LOW`` result to :c:func:`nrf_modem_init()` function.
340+
* Added the ``MODEM_DFU_RESULT_VOLTAGE_LOW`` result to :c:func:`nrf_modem_init` function.
341341
The new value is returned when the voltage is too low for the modem firmware to execute the scheduled modem firmware update.
342342
The application can retry the operation by re-initializing the modem when the voltage has increased.
343343
Requires modem firmware v1.3.4 or newer.
@@ -346,11 +346,11 @@ nrf_modem 2.2.1
346346
nrf_modem 2.2.0
347347
***************
348348

349-
* Added a ``timeout`` parameter to the :c:func:`nrf_modem_trace_get()` function.
349+
* Added a ``timeout`` parameter to the :c:func:`nrf_modem_trace_get` function.
350350
* Fixed an issue when compiling the :file:`nrf_modem.h` header in C++.
351351
* The Delta DFU interface (:file:`nrf_modem_delta_dfu.h`) is now thread safe.
352-
* Fixed possible race conditions in the :c:func:`nrf_modem_init()` and :c:func:`nrf_modem_shutdown()` functions.
353-
* Fixed a bug in :c:func:`nrf_listen()` function that let the queue of incoming connection requests be of size one.
352+
* Fixed possible race conditions in the :c:func:`nrf_modem_init` and :c:func:`nrf_modem_shutdown` functions.
353+
* Fixed a bug in :c:func:`nrf_listen` function that let the queue of incoming connection requests be of size one.
354354
* The :c:data:`NRF_MODEM_GNSS_EVT_BLOCKED` event is now sent only when the GNSS stack does not get any runtime due to LTE activity, whereas earlier it could also be sent when the GNSS stack average runtime was too short.
355355
* Removed the usage of the application software interrupt. The library uses only the IPC peripheral interrupt now.
356356
* Removed the :c:func:`nrf_modem_application_irq_handler` function.

nrf_rpc/CHANGELOG.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Changes
1616
=======
1717

1818
* Enabled zcbor's :c:member:`stop_on_error` flag before decoding the CBOR payload of an nRF RPC packet.
19-
When this flag is set, zcbor stops decoding subsequent data items in the case of decoding failure unless the error is explicitly cleared with the :c:func:`zcbor_pop_error()` function.
19+
When this flag is set, zcbor stops decoding subsequent data items in the case of decoding failure unless the error is explicitly cleared with the :c:func:`zcbor_pop_error` function.
2020

2121
nRF Connect SDK v2.5.0
2222
**********************

0 commit comments

Comments
 (0)