From 2d9418fbb2d9dcf6b7b29510010fde6c39ef37ca Mon Sep 17 00:00:00 2001 From: ENGO150 <v.smejkal06@gmail.com> Date: Sat, 25 Jan 2025 18:35:41 +0100 Subject: [PATCH] created doc for why2_reset_memory_identifier --- .../setters/why2_reset_memory_identifier.md | 37 +++++++++++++++++++ docs/functions/index.md | 1 + 2 files changed, 38 insertions(+) create mode 100644 docs/functions/core/flags/setters/why2_reset_memory_identifier.md diff --git a/docs/functions/core/flags/setters/why2_reset_memory_identifier.md b/docs/functions/core/flags/setters/why2_reset_memory_identifier.md new file mode 100644 index 0000000..33ccb2b --- /dev/null +++ b/docs/functions/core/flags/setters/why2_reset_memory_identifier.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_reset_memory_identifier + +## Parameters + +*This functions doesn't take any parameters.* + +## Attributes + +| | | +| ------------------ | ---------------------------------------------- | +| **Return type** | `void` | +| **Header comment** | *This functions doesn't have any description.* | +| **Added in commit** | [`70335e67ad3e7ef3bc693741a03cb91962b91863`](https://github.com/ENGO150/WHY2/commit/70335e67ad3e7ef3bc693741a03cb91962b91863) | + +## Description + +Resets string, used in garbage collector for identifying (separating) nodes, to default. + +Every allocation has its own ID, which is set to lastly used `memory_identifier`. This separates allocations in code to blocks and you can run GC with the `memory_identifier` to deallocate those blocks. \ No newline at end of file diff --git a/docs/functions/index.md b/docs/functions/index.md index 0d404f4..8d885a0 100644 --- a/docs/functions/index.md +++ b/docs/functions/index.md @@ -70,6 +70,7 @@ You can find documentation for every *public* function of WHY2 below. | [`why2_set_encryption_operation`](./core/flags/setters/why2_set_encryption_operation) | *This functions doesn't have any description.* | | [`why2_set_memory_identifier`](./core/flags/setters/why2_set_memory_identifier) | *This functions doesn't have any description.* | | [`why2_set_padding`](./core/flags/setters/why2_set_padding) | Set padding rate without rewriting input flags | +| [`why2_reset_memory_identifier`](./core/flags/setters/why2_reset_memory_identifier) | *This functions doesn't have any description.* | ## Logger