From ab79a779ace632ba68b427719d74fbe75ecb48d7 Mon Sep 17 00:00:00 2001 From: ENGO150 Date: Sat, 25 Jan 2025 20:24:50 +0100 Subject: [PATCH] created doc for why2_list_remove_at --- .../core/llist/why2_list_remove_at.md | 38 +++++++++++++++++++ docs/functions/index.md | 1 + 2 files changed, 39 insertions(+) create mode 100644 docs/functions/core/llist/why2_list_remove_at.md diff --git a/docs/functions/core/llist/why2_list_remove_at.md b/docs/functions/core/llist/why2_list_remove_at.md new file mode 100644 index 0000000..b7daa7a --- /dev/null +++ b/docs/functions/core/llist/why2_list_remove_at.md @@ -0,0 +1,38 @@ + + +# why2_list_remove_at + +## Parameters + +| Identifier | Data type | +| ---------- | ----------------------------------------------------------- | +| `list` | [`why2_list_t *`](../../../../types/core/llist/why2_list_t) | +| `index` | `unsigned long` | + +## Attributes + +| | | +| ------------------ | --------------------------------------------------------------------- | +| **Return type** | `void` | +| **Header comment** | `REMOVE ELEMENT WITH INDEX index` | +| **Added in commit** | [`90643d82470dba0c5aaf884a231a55894b8dd39f`](https://github.com/ENGO150/WHY2/commit/90643d82470dba0c5aaf884a231a55894b8dd39f) | + +## Description + +Removes node on `index` from linked-list (`list`). \ No newline at end of file diff --git a/docs/functions/index.md b/docs/functions/index.md index a1a52bc..a359a51 100644 --- a/docs/functions/index.md +++ b/docs/functions/index.md @@ -79,6 +79,7 @@ You can find documentation for every *public* function of WHY2 below. | [`why2_list_push`](./core/llist/why2_list_push) | Push element to list back | | [`why2_list_push_at`](./core/llist/why2_list_push_at) | Push element to index index of list | | [`why2_list_remove`](./core/llist/why2_list_remove) | Remove element | +| [`why2_list_remove_at`](./core/llist/why2_list_remove_at) | Remove element with index index | ## Logger