created doc for why2_list_reverse

This commit is contained in:
Václav Šmejkal 2025-01-25 20:41:26 +01:00
parent 5550e41b2c
commit b8c9df87da
Signed by: ENGO150
GPG Key ID: 4A57E86482968843
2 changed files with 39 additions and 0 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_reverse
## Parameters
| Identifier | Data type |
| ---------- | ----------------------------------------------------------- |
| `list` | [`why2_list_t *`](../../../../types/core/llist/why2_list_t) |
| `size` | `unsigned long` |
## Attributes
| | |
| ------------------ | --------------------------------------------------------------------- |
| **Return type** | `void` |
| **Header comment** | `REVERSES list` |
| **Added in commit** | [`7dcbd4fc80fa13e5f9d0d4fe90a742c0f8dfab3d`](https://github.com/ENGO150/WHY2/commit/7dcbd4fc80fa13e5f9d0d4fe90a742c0f8dfab3d) |
## Description
Reverses node order in `list`. `size` is size of nodes in `list`, because of the reallocations.

View File

@ -83,6 +83,7 @@ You can find documentation for every *public* function of WHY2 below.
| [`why2_list_remove_back`](./core/llist/why2_list_remove_back) | Remove last element |
| [`why2_list_find`](./core/llist/why2_list_find) | Find element in list |
| [`why2_list_get_size`](./core/llist/why2_list_get_size) | Get size |
| [`why2_list_reverse`](./core/llist/why2_list_reverse) | Reverses list |
## Logger