ENGO150/WHY2-docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

created doc for why2_list_remove_at

Browse Source
This commit is contained in:
Václav Šmejkal 2025-01-25 20:24:50 +01:00
parent 5e808083ae
commit ab79a779ac
Signed by: ENGO150
GPG Key ID: 4A57E86482968843
2 changed files with 39 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/functions/core/llist/why2_list_remove_at.md Normal file
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_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`).

1
docs/functions/index.md
View File

@ -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`](./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 | | [`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 ## Logger