Modified fetch_add and fetch_sub documentation

This commit is contained in:
John Wellbelove 2026-10-16 11:18:15 +01:00
parent d50277f5bb
commit 641d47d033

View File

@ -192,6 +192,11 @@ Atomically obtains the value of the atomic object.
T fetch_add(T v, etl::memory_order order = etl::memory_order_seq_cst) T fetch_add(T v, etl::memory_order order = etl::memory_order_seq_cst)
T fetch_add(T v, etl::memory_order order = etl::memory_order_seq_cst) volatile T fetch_add(T v, etl::memory_order order = etl::memory_order_seq_cst) volatile
``` ```
```cpp
T* fetch_add(ptrdiff_t v, etl::memory_order order = etl::memory_order_seq_cst)
T* fetch_add(ptrdiff_t v, etl::memory_order order = etl::memory_order_seq_cst) volatile
```
**Description** **Description**
Atomically adds the argument to the value stored in the atomic object and obtains the value held previously. Atomically adds the argument to the value stored in the atomic object and obtains the value held previously.
@ -201,6 +206,11 @@ Atomically adds the argument to the value stored in the atomic object and obtain
T fetch_sub(T v, etl::memory_order order = etl::memory_order_seq_cst) T fetch_sub(T v, etl::memory_order order = etl::memory_order_seq_cst)
T fetch_sub(T v, etl::memory_order order = etl::memory_order_seq_cst) volatile T fetch_sub(T v, etl::memory_order order = etl::memory_order_seq_cst) volatile
``` ```
```cpp
T* fetch_sub(ptrdiff_t v, etl::memory_order order = etl::memory_order_seq_cst)
T* fetch_sub(ptrdiff_t v, etl::memory_order order = etl::memory_order_seq_cst) volatile
```
**Description** **Description**
Atomically subtracts the argument to the value stored in the atomic object and obtains the value held previously. Atomically subtracts the argument to the value stored in the atomic object and obtains the value held previously.