created doc for why2_opendir
This commit is contained in:
parent
11e3739704
commit
6b1abd755f
37
docs/functions/core/memory/why2_opendir.md
Normal file
37
docs/functions/core/memory/why2_opendir.md
Normal 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_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.
|
@ -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_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.* |
|
||||||
|
|
||||||
## Logger
|
## Logger
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user