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

created doc for why2_allocated

Browse Source
This commit is contained in:
Václav Šmejkal 2025-01-25 21:26:15 +01:00
parent d438578f6e
commit 07d150c19d
Signed by: ENGO150
GPG Key ID: 4A57E86482968843
2 changed files with 38 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/functions/core/memory/why2_allocated.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_allocated
## Parameters
| Identifier | Data type |
| ---------- | --------- |
| `pointer` | `void *` |
## Attributes
| | |
| ------------------ | ----------------------------------------------------- |
| **Return type** | [`why2_bool`](../../../../types/core/flags/why2_bool) |
| **Header comment** | `CHECKS IF pointer WAS ALLOCATED USING WHY2-MEM` |
| **Added in commit** | [`65135ac96161eaa236b37ca2f3ace64345bbba66`](https://github.com/ENGO150/WHY2/commit/65135ac96161eaa236b37ca2f3ace64345bbba66) |
## Description
Function searches [`linked-list`](../../../../types/core/llist/why2_list_t) for `pointer`. If found, `false` is returned, otherwise `true` is returned.

1
docs/functions/index.md
View File

@ -99,6 +99,7 @@ You can find documentation for every *public* function of WHY2 below.
| [`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.* | | [`why2_deallocate`](./core/memory/why2_deallocate) | *This functions doesn't have any description.* |
| [`why2_clean_memory`](./core/memory/why2_clean_memory) | identifier specifies which nodes to deallocate \| this is basically garbage collector \| pass why2_get_default_memory_identifier() for deallocating everything | | [`why2_clean_memory`](./core/memory/why2_clean_memory) | identifier specifies which nodes to deallocate \| this is basically garbage collector \| pass why2_get_default_memory_identifier() for deallocating everything |
| [`why2_allocated`](./core/memory/why2_allocated) | Checks if pointer was allocated using why2-mem |
## Logger ## Logger