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

created doc for why2_realloc

Browse Source
This commit is contained in:
Václav Šmejkal 2025-01-25 20:57:31 +01:00
parent e8b818bba3
commit 10d5402775
Signed by: ENGO150
GPG Key ID: 4A57E86482968843
2 changed files with 43 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/functions/core/memory/why2_realloc.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_realloc
## Parameters
| Identifier | Data type |
| ---------- | --------------- |
| `pointer` | `void *` |
| `size` | `unsigned long` |
## Attributes
| | |
| ------------------ | ---------------------------------------------- |
| **Return type** | `void *` |
| **Header comment** | `THIS DOESN'T PRESERVE CONTENT OF pointer!` |
| **Added in commit** | [`8af6bd45c38e780bb14d99aee0a572b028c186b6`](https://github.com/ENGO150/WHY2/commit/8af6bd45c38e780bb14d99aee0a572b028c186b6) |
## Description
Function deallocates `pointer` (only applicable if `pointer` was allocated using WHY2-memory), passes `size` into [`malloc`](https://linux.die.net/man/3/malloc) function and returns the output value. The value is also pushed to [`linked-list`](../../../../types/core/llist/why2_list_t) for garbage collector.

9
docs/functions/index.md
View File

@ -87,10 +87,11 @@ You can find documentation for every *public* function of WHY2 below.
### Memory
| Function | Description |
| ------------------------------------------ | ---------------------------------------------- |
| [`why2_malloc`](./core/memory/why2_malloc) | *This functions doesn't have any description.* |
| [`why2_calloc`](./core/memory/why2_calloc) | *This functions doesn't have any description.* |
| Function | Description |
| -------------------------------------------- | ---------------------------------------------- |
| [`why2_malloc`](./core/memory/why2_malloc) | *This functions doesn't have any description.* |
| [`why2_calloc`](./core/memory/why2_calloc) | *This functions doesn't have any description.* |
| [`why2_realloc`](./core/memory/why2_realloc) | This doesn't preserve content of pointer! |
## Logger