created doc for why2_list_remove

This commit is contained in:
Václav Šmejkal 2025-01-25 20:21:43 +01:00
parent 4e63a33abf
commit 5e808083ae
Signed by: ENGO150
GPG Key ID: 4A57E86482968843
2 changed files with 43 additions and 4 deletions

View File

@ -0,0 +1,38 @@
<!--
This is part of WHY2
Copyright (C) 2022 Václav Šmejkal
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
-->
# 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`).

View File

@ -75,9 +75,10 @@ You can find documentation for every *public* function of WHY2 below.
### Linked-list ### Linked-list
| Function | Description | | Function | Description |
| ----------------------------------------------------- | ----------------------------------- | | --------------------------------------------------------- | ----------------------------------- |
| [`why2_list_push`](./core/llist/why2_list_push) | Push element to list back | | [`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_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 ## Logger