diff --git a/docs/functions/core/llist/why2_list_remove.md b/docs/functions/core/llist/why2_list_remove.md new file mode 100644 index 0000000..00a11fd --- /dev/null +++ b/docs/functions/core/llist/why2_list_remove.md @@ -0,0 +1,38 @@ + + +# why2_list_remove + +## Parameters + +| Identifier | Data type | +| ---------- | ----------------------------------------------------------- | +| `list` | [`why2_list_t *`](../../../../types/core/llist/why2_list_t) | +| `node` | [`why2_node_t *`](../../../../types/core/llist/why2_node_t) | + +## Attributes + +| | | +| ------------------ | --------------------------------------------------------------------- | +| **Return type** | `void` | +| **Header comment** | `REMOVE ELEMENT` | +| **Added in commit** | [`10632e00703f0935d963c1e2133940c061eb8ed3`](https://github.com/ENGO150/WHY2/commit/10632e00703f0935d963c1e2133940c061eb8ed3) | + +## Description + +Removes `node` from linked-list (`list`). \ No newline at end of file diff --git a/docs/functions/index.md b/docs/functions/index.md index c9a0034..a1a52bc 100644 --- a/docs/functions/index.md +++ b/docs/functions/index.md @@ -74,10 +74,11 @@ You can find documentation for every *public* function of WHY2 below. ### Linked-list -| Function | Description | -| ----------------------------------------------------- | ----------------------------------- | -| [`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 | +| Function | Description | +| --------------------------------------------------------- | ----------------------------------- | +| [`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 | ## Logger