diff options
| author | Tyge Løvset <[email protected]> | 2021-06-03 16:34:24 +0200 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2021-06-03 16:34:24 +0200 |
| commit | 202e34f71c154983cef821b488ec696bfc9c4f7b (patch) | |
| tree | 3a956491234e64e1b5a28c305900a30d76b3d4af | |
| parent | f9aba655cb8ecb11e1e956122e8821624c41d2b8 (diff) | |
| download | STC-modified-202e34f71c154983cef821b488ec696bfc9c4f7b.tar.gz STC-modified-202e34f71c154983cef821b488ec696bfc9c4f7b.zip | |
Removed c_forbuffer in docs. May be removed in future.
| -rw-r--r-- | docs/ccommon_api.md | 5 |
1 files changed, 0 insertions, 5 deletions
diff --git a/docs/ccommon_api.md b/docs/ccommon_api.md index 83d9e12e..92687056 100644 --- a/docs/ccommon_api.md +++ b/docs/ccommon_api.md @@ -11,17 +11,12 @@ of a `c_forvar` / `c_fordefer`-block. ***Do not*** use `return`, `goto` or `brea `end`-statement to be executed at the end. The same applies for `c_forbuffer`. This is not particular to the `c_for*()` macros, as one must always make sure to unwind temporary allocated resources before `return` in C. -There is also a **c_forbuffer** macro which uses stack memory if buffer is <= to 256 bytes, othewise it uses -the slower heap memory. - | Usage | Description | |:---------------------------------------|:--------------------------------------------------| | `c_fordefer (end...)` | Defer execution of `end` to end of block | | `c_forscope (start, end)` | Execute `start`. Defer `end` to end of block | | `c_forvar (Type var=init, end...)` | Declare `var`. Defer `end` to end of block | | `c_forvar_initdel (Type, var...)` | `c_forvar (Type var=Type_init(), Type_del(&var))` | -| | | -| `c_forbuffer (buf, type, n)` | Declare, allocate and free memory buffer | For multiple variables, use either multiple **c_forvar** in sequence, or declare variable outside scope and use **c_fordefer** or **c_forscope**. Also, **c_forvar_initdel** support up to 3 vars. |
