created doc for why2_get_encryption_separator
This commit is contained in:
parent
c6189e7b10
commit
17c16325e2
docs/functions
@ -0,0 +1,43 @@
|
||||
<!--
|
||||
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_encryption_separator
|
||||
|
||||
## Parameters
|
||||
|
||||
*This functions doesn't take any parameters.*
|
||||
|
||||
## Attributes
|
||||
|
||||
| | |
|
||||
| ------------------ | ---------------------------------------------- |
|
||||
| **Return type** | `char` |
|
||||
| **Header comment** | *This functions doesn't have any description.* |
|
||||
| **Added in commit** | [`1a5b58edf99547ba32fb047e80fb179f315182b9`](https://github.com/ENGO150/WHY2/commit/1a5b58edf99547ba32fb047e80fb179f315182b9) |
|
||||
|
||||
## Description
|
||||
|
||||
Returns `encryption_separator`, which is used in encryption/decryption for separating chars.
|
||||
|
||||
---
|
||||
|
||||
```
|
||||
104'-100'10306'-110'87
|
||||
```
|
||||
|
||||
Example above uses `'` as `encryption_separator`.
|
@ -43,6 +43,14 @@ You can find documentation for every *public* function of WHY2 below.
|
||||
| --------------------------------------------------------- | ------------------------------------------------- |
|
||||
| [`why2_encrypt_text`](./core/encrypter/why2_encrypt_text) | Text from will be encrypted with key and returned |
|
||||
|
||||
### Flags
|
||||
|
||||
#### Getters
|
||||
|
||||
| Function | Description |
|
||||
| ----------------------------------------------------------------------------- | --------------------------------------- |
|
||||
| [`why2_get_encryption_separator`](./core/flags/getters/why2_get_encryption_separator) | *This functions doesn't have any description.* |
|
||||
|
||||
## Logger
|
||||
|
||||
## Chat
|
Loading…
x
Reference in New Issue
Block a user