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

created doc for why2_deallocate

Browse Source
This commit is contained in:
Václav Šmejkal 2025-01-25 21:13:14 +01:00
parent 6b1abd755f
commit ba54f62f4d
Signed by: ENGO150
GPG Key ID: 4A57E86482968843
2 changed files with 48 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/functions/core/memory/why2_deallocate.md Normal file
View File

@ -0,0 +1,37 @@
<!--
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_deallocate
## Parameters
| Identifier | Data type |
| ---------- | --------- |
| `pointer` | `void *` |
## Attributes
| | |
| ------------------ | ---------------------------------------------- |
| **Return type** | `void` |
| **Header comment** | *This functions doesn't have any description.* |
| **Added in commit** | [`3491d89a86eba805c3f42543a431cae33bae146b`](https://github.com/ENGO150/WHY2/commit/3491d89a86eba805c3f42543a431cae33bae146b) |
## Description
Function passes `pointer` into corresponding deallocation function ([`free`](https://linux.die.net/man/3/free), [`fclose`](https://linux.die.net/man/3/fclose) or [`closedir`](https://linux.die.net/man/3/closedir)). The value is also removed from [`linked-list`](../../../../types/core/llist/why2_list_t).

21
docs/functions/index.md
View File

@ -87,16 +87,17 @@ You can find documentation for every *public* function of WHY2 below.
### Memory ### Memory
| Function | Description | | Function | Description |
| ---------------------------------------------- | ---------------------------------------------------------- | | -------------------------------------------------- | ---------------------------------------------------------- |
| [`why2_malloc`](./core/memory/why2_malloc) | *This functions doesn't have any 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_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! | | [`why2_realloc`](./core/memory/why2_realloc) | This doesn't preserve content of pointer! |
| [`why2_recalloc`](./core/memory/why2_recalloc) | Same as why2_realloc but fills the pointer with null-terms | | [`why2_recalloc`](./core/memory/why2_recalloc) | Same as why2_realloc but fills the pointer with null-terms |
| [`why2_strdup`](./core/memory/why2_strdup) | *This functions doesn't have any description.* | | [`why2_strdup`](./core/memory/why2_strdup) | *This functions doesn't have any description.* |
| [`why2_fopen`](./core/memory/why2_fopen) | *This functions doesn't have any description.* | | [`why2_fopen`](./core/memory/why2_fopen) | *This functions doesn't have any description.* |
| [`why2_fdopen`](./core/memory/why2_fdopen) | *This functions doesn't have any description.* | | [`why2_fdopen`](./core/memory/why2_fdopen) | *This functions doesn't have any description.* |
| [`why2_opendir`](./core/memory/why2_opendir) | *This functions doesn't have any description.* | | [`why2_opendir`](./core/memory/why2_opendir) | *This functions doesn't have any description.* |
| [`why2_deallocate`](./core/memory/why2_deallocate) | *This functions doesn't have any description.* |
## Logger ## Logger