diff --git a/docs/functions/core/flags/getters/why2_get_default_memory_identifier.md b/docs/functions/core/flags/getters/why2_get_default_memory_identifier.md new file mode 100644 index 0000000..95908d8 --- /dev/null +++ b/docs/functions/core/flags/getters/why2_get_default_memory_identifier.md @@ -0,0 +1,37 @@ + + +# why2_get_default_memory_identifier + +## Parameters + +*This functions doesn't take any parameters.* + +## Attributes + +| | | +| ------------------ | ---------------------------------------------- | +| **Return type** | `char *` | +| **Header comment** | *This functions doesn't have any description.* | +| **Added in commit** | [`aa6b484363ad609f1bf1ff5ee539723d9417f48a`](https://github.com/ENGO150/WHY2/commit/aa6b484363ad609f1bf1ff5ee539723d9417f48a) | + +## Description + +Returns string, which is by default used in garbage collector for identifying (separating) nodes. + +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 0c8a113..498b07e 100644 --- a/docs/functions/index.md +++ b/docs/functions/index.md @@ -58,6 +58,7 @@ You can find documentation for every *public* function of WHY2 below. | [`why2_get_flags_changed`](./core/flags/getters/why2_get_flags_changed) | *This functions doesn't have any description.* | | [`why2_get_padding_changed`](./core/flags/getters/why2_get_padding_changed) | *This functions doesn't have any description.* | | [`why2_get_memory_identifier`](./core/flags/getters/why2_get_memory_identifier) | Returns string used in linked list (in memory.c) for identifying nodes when running garbage collector | +| [`why2_get_default_memory_identifier`](./core/flags/getters/why2_get_default_memory_identifier) | *This functions doesn't have any description.* | ## Logger