created doc for why2_get_default_memory_identifier
This commit is contained in:
parent
87d1c2b79c
commit
bd831ad097
@ -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_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.
|
@ -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_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_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_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
|
## Logger
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user