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

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

diff --git a/docs/functions/core/memory/why2_opendir.md b/docs/functions/core/memory/why2_opendir.md
new file mode 100644
index 0000000..481a930
--- /dev/null
+++ b/docs/functions/core/memory/why2_opendir.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_opendir
+
+## Parameters
+
+| Identifier | Data type |
+| ---------- | --------- |
+| `name`     | `char *`  |
+
+## Attributes
+
+|                     |                                                |
+| ------------------  | ---------------------------------------------- |
+| **Return type**     | `void *`                                       |
+| **Header comment**  | *This functions doesn't have any description.* |
+| **Added in commit** | [`1285f52b6737093f802163b3dc313253ea96f5bc`](https://github.com/ENGO150/WHY2/commit/1285f52b6737093f802163b3dc313253ea96f5bc) |
+
+## Description
+
+Function passes `name` into [`opendir`](https://linux.die.net/man/3/opendir) 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 1313015..422ab33 100644
--- a/docs/functions/index.md
+++ b/docs/functions/index.md
@@ -96,6 +96,7 @@ You can find documentation for every *public* function of WHY2 below.
 | [`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_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.*             |
 
 ## Logger