created doc for why2_set_encryption_separator

This commit is contained in:
Václav Šmejkal 2025-01-25 18:14:20 +01:00
parent 9f7232ddb2
commit b06eb9e230
Signed by: ENGO150
GPG Key ID: 4A57E86482968843
2 changed files with 51 additions and 0 deletions

View File

@ -0,0 +1,45 @@
<!--
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_set_encryption_separator
## Parameters
| Identifier | Data type |
| ----------------------------- | --------- |
| `encryption_separator_new` | `char` |
## Attributes
| | |
| ------------------ | ---------------------------------------------- |
| **Return type** | `void` |
| **Header comment** | *This functions doesn't have any description.* |
| **Added in commit** | [`1a5b58edf99547ba32fb047e80fb179f315182b9`](https://github.com/ENGO150/WHY2/commit/1a5b58edf99547ba32fb047e80fb179f315182b9) |
## Description
Sets `encryption_separator`, which is used in encryption/decryption for separating chars.
---
```
104'-100'10306'-110'87
```
Example above uses `'` as `encryption_separator`.

View File

@ -60,6 +60,12 @@ You can find documentation for every *public* function of WHY2 below.
| [`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.* | | [`why2_get_default_memory_identifier`](./core/flags/getters/why2_get_default_memory_identifier) | *This functions doesn't have any description.* |
#### Setters
| Function | Description |
| --------------------------------------------------------------------- | ------------------------------------------------- |
| [`why2_set_encryption_separator`](./core/flags/setters/why2_set_encryption_separator) | *This functions doesn't have any description.* |
## Logger ## Logger
## Chat ## Chat