From c6189e7b106321482eb92b5bcc0ba87b099f2e74 Mon Sep 17 00:00:00 2001
From: ENGO150 <v.smejkal06@gmail.com>
Date: Sat, 25 Jan 2025 15:50:39 +0100
Subject: [PATCH] created doc for why2_encrypt_text

---
 .../core/encrypter/why2_encrypt_text.md       | 40 +++++++++++++++++++
 docs/functions/index.md                       |  8 +++-
 2 files changed, 47 insertions(+), 1 deletion(-)
 create mode 100644 docs/functions/core/encrypter/why2_encrypt_text.md

diff --git a/docs/functions/core/encrypter/why2_encrypt_text.md b/docs/functions/core/encrypter/why2_encrypt_text.md
new file mode 100644
index 0000000..da2f71d
--- /dev/null
+++ b/docs/functions/core/encrypter/why2_encrypt_text.md
@@ -0,0 +1,40 @@
+<!--
+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_encrypt_text
+
+## Parameters
+
+| Identifier | Data type |
+| ---------- | --------- |
+| `text`     | `char *`  |
+| `key`      | `char *`  |
+
+## Attributes
+
+|                     |                                                                       |
+| ------------------  | --------------------------------------------------------------------- |
+| **Return type**     | [`why2_output_flags`](../../../../types/core/flags/why2_output_flags) |
+| **Header comment**  | `TEXT from WILL BE ENCRYPTED WITH key AND RETURNED`                   |
+| **Added in commit** | [`d9a99b985105b99b3ef237597f8ea91a751b89f1`](https://github.com/ENGO150/WHY2/commit/d9a99b985105b99b3ef237597f8ea91a751b89f1) |
+
+## Description
+
+Function adds padding (if enabled) to `text` using `key`, encrypts and returns output in [`why2_output_flags`](../../../../types/core/flags/why2_output_flags) among with some run data.
+
+Encryption/Decryption functions are using settings from [`why2_input_flags`](../../../../types/core/flags/why2_input_flags). You can set those using [`why2_set_flags`](../../../../functions/core/flags/why2_set_flags).
\ No newline at end of file
diff --git a/docs/functions/index.md b/docs/functions/index.md
index f6a1476..8adc311 100644
--- a/docs/functions/index.md
+++ b/docs/functions/index.md
@@ -35,7 +35,13 @@ You can find documentation for every *public* function of WHY2 below.
 
 | Function                                                  | Description                                       |
 | --------------------------------------------------------- | ------------------------------------------------- |
-| [`why2_decrypt_text`](./core/decrypter/why2_decrypt_text) | Text from Will be decrypter with key and returned |
+| [`why2_decrypt_text`](./core/decrypter/why2_decrypt_text) | Text from will be decrypted with key and returned |
+
+### Encrypter
+
+| Function                                                  | Description                                       |
+| --------------------------------------------------------- | ------------------------------------------------- |
+| [`why2_encrypt_text`](./core/encrypter/why2_encrypt_text) | Text from will be encrypted with key and returned |
 
 ## Logger