From 07d150c19de22d4fcf788f8b6891f92d88953cf2 Mon Sep 17 00:00:00 2001
From: ENGO150 <v.smejkal06@gmail.com>
Date: Sat, 25 Jan 2025 21:26:15 +0100
Subject: [PATCH] created doc for why2_allocated

---
 docs/functions/core/memory/why2_allocated.md | 37 ++++++++++++++++++++
 docs/functions/index.md                      |  1 +
 2 files changed, 38 insertions(+)
 create mode 100644 docs/functions/core/memory/why2_allocated.md

diff --git a/docs/functions/core/memory/why2_allocated.md b/docs/functions/core/memory/why2_allocated.md
new file mode 100644
index 0000000..668699c
--- /dev/null
+++ b/docs/functions/core/memory/why2_allocated.md
@@ -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.
\ No newline at end of file
diff --git a/docs/functions/index.md b/docs/functions/index.md
index 276cbb6..120acd2 100644
--- a/docs/functions/index.md
+++ b/docs/functions/index.md
@@ -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_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_allocated`](./core/memory/why2_allocated)       | Checks if pointer was allocated using why2-mem             |
 
 ## Logger