From 4e63a33abfe82b7f8184666725e281033c35d684 Mon Sep 17 00:00:00 2001 From: ENGO150 Date: Sat, 25 Jan 2025 20:17:29 +0100 Subject: [PATCH] created doc for why2_list_push_at --- .../functions/core/llist/why2_list_push_at.md | 42 +++++++++++++++++++ docs/functions/index.md | 1 + 2 files changed, 43 insertions(+) create mode 100644 docs/functions/core/llist/why2_list_push_at.md diff --git a/docs/functions/core/llist/why2_list_push_at.md b/docs/functions/core/llist/why2_list_push_at.md new file mode 100644 index 0000000..cd204ae --- /dev/null +++ b/docs/functions/core/llist/why2_list_push_at.md @@ -0,0 +1,42 @@ + + +# why2_list_push_at + +## Parameters + +| Identifier | Data type | +| ---------- | ----------------------------------------------------------- | +| `list` | [`why2_list_t *`](../../../../types/core/llist/why2_list_t) | +| `index` | `unsigned long` | +| `value` | `void *` | +| `size` | `unsigned long` | + +## Attributes + +| | | +| ------------------ | --------------------------------------------------------------------- | +| **Return type** | `void` | +| **Header comment** | `PUSH ELEMENT TO INDEX index of LIST` | +| **Added in commit** | [`0e246be627c33f33d82a0fb2e5b43dd3fa024e0c`](https://github.com/ENGO150/WHY2/commit/0e246be627c33f33d82a0fb2e5b43dd3fa024e0c) | + +## Description + +Function appends new node containing `value` of `size` to the `index` position of linked-list (`list`). + +`index` starts with 0. \ No newline at end of file diff --git a/docs/functions/index.md b/docs/functions/index.md index 581d412..c9a0034 100644 --- a/docs/functions/index.md +++ b/docs/functions/index.md @@ -77,6 +77,7 @@ You can find documentation for every *public* function of WHY2 below. | Function | Description | | ----------------------------------------------------- | ----------------------------------- | | [`why2_list_push`](./core/llist/why2_list_push) | Push element to list back | +| [`why2_list_push_at`](./core/llist/why2_list_push_at) | Push element to index index of list | ## Logger