From aa10164390393abfef657217c10bfef953e70fcb Mon Sep 17 00:00:00 2001 From: ENGO150 Date: Sat, 25 Jan 2025 21:03:45 +0100 Subject: [PATCH] created doc for why2_fopen --- docs/functions/core/memory/why2_fopen.md | 38 ++++++++++++++++++++++++ docs/functions/index.md | 1 + 2 files changed, 39 insertions(+) create mode 100644 docs/functions/core/memory/why2_fopen.md diff --git a/docs/functions/core/memory/why2_fopen.md b/docs/functions/core/memory/why2_fopen.md new file mode 100644 index 0000000..f1745ed --- /dev/null +++ b/docs/functions/core/memory/why2_fopen.md @@ -0,0 +1,38 @@ + + +# why2_fopen + +## Parameters + +| Identifier | Data type | +| ---------- | --------- | +| `name` | `char *` | +| `modes` | `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` and `modes` into [`fopen`](https://linux.die.net/man/3/fopen) 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 23a7f95..92c81e9 100644 --- a/docs/functions/index.md +++ b/docs/functions/index.md @@ -94,6 +94,7 @@ You can find documentation for every *public* function of WHY2 below. | [`why2_realloc`](./core/memory/why2_realloc) | This doesn't preserve content of pointer! | | [`why2_recalloc`](./core/memory/why2_recalloc) | Same as why2_realloc but fills the pointer with null-terms | | [`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.* | ## Logger