From 9f5f9659805ee138ff0589ec0d0c6db01a9c4e95 Mon Sep 17 00:00:00 2001
From: ENGO150 <v.smejkal06@gmail.com>
Date: Sat, 25 Jan 2025 20:50:59 +0100
Subject: [PATCH] created doc for why2_malloc

---
 docs/functions/core/memory/why2_malloc.md | 37 +++++++++++++++++++++++
 docs/functions/index.md                   |  6 ++++
 2 files changed, 43 insertions(+)
 create mode 100644 docs/functions/core/memory/why2_malloc.md

diff --git a/docs/functions/core/memory/why2_malloc.md b/docs/functions/core/memory/why2_malloc.md
new file mode 100644
index 0000000..253e2de
--- /dev/null
+++ b/docs/functions/core/memory/why2_malloc.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_malloc
+
+## Parameters
+
+| Identifier | Data type       |
+| ---------- | --------------- |
+| `size`     | `unsigned long` |
+
+## Attributes
+
+|                     |                                                |
+| ------------------  | ---------------------------------------------- |
+| **Return type**     | `void *`                                       |
+| **Header comment**  | *This functions doesn't have any description.* |
+| **Added in commit** | [`9c7f40a82528846b6585294b12c5a30e5f1e4533`](https://github.com/ENGO150/WHY2/commit/9c7f40a82528846b6585294b12c5a30e5f1e4533) |
+
+## Description
+
+Function passes `size` into [`malloc`](https://sourceware.org/glibc/wiki/MallocInternals) function and returns the output value. The value is also pushed to [`linked-list`](../../../../types/core/llist/why2_list_t) for garbage collector.
\ No newline at end of file
diff --git a/docs/functions/index.md b/docs/functions/index.md
index 31d7b48..8640261 100644
--- a/docs/functions/index.md
+++ b/docs/functions/index.md
@@ -85,6 +85,12 @@ You can find documentation for every *public* function of WHY2 below.
 | [`why2_list_get_size`](./core/llist/why2_list_get_size)       | Get size                            |
 | [`why2_list_reverse`](./core/llist/why2_list_reverse)         | Reverses list                       |
 
+### Memory
+
+| Function                                   | Description                                    |
+| ------------------------------------------ | ---------------------------------------------- |
+| [`why2_malloc`](./core/memory/why2_malloc) | *This functions doesn't have any description.* |
+
 ## Logger
 
 ## Chat
\ No newline at end of file