From 28f75e750526b6c6e95d31182b1b3daf1160ddf4 Mon Sep 17 00:00:00 2001 From: ENGO150 Date: Sat, 25 Jan 2025 16:46:09 +0100 Subject: [PATCH] created doc for why2_get_encryption_operation --- .../getters/why2_get_encryption_operation.md | 35 +++++++++++++++++++ docs/functions/index.md | 1 + 2 files changed, 36 insertions(+) create mode 100644 docs/functions/core/flags/getters/why2_get_encryption_operation.md diff --git a/docs/functions/core/flags/getters/why2_get_encryption_operation.md b/docs/functions/core/flags/getters/why2_get_encryption_operation.md new file mode 100644 index 0000000..6171283 --- /dev/null +++ b/docs/functions/core/flags/getters/why2_get_encryption_operation.md @@ -0,0 +1,35 @@ + + +# why2_get_encryption_operation + +## Parameters + +*This functions doesn't take any parameters.* + +## Attributes + +| | | +| ------------------ | ------------------------------------------------------------------------------------------- | +| **Return type** | [`why2_encryption_operation_cb`](../../../../types/core/flags/why2_encryption_operation_cb) | +| **Header comment** | `RETURNS FUNCTION WHICH IS USED FOR ENCRYPTION & DECRYPTION` | +| **Added in commit** | [`2a09a38acf48f0e57beb5135ab7f1fdb18e088fa`](https://github.com/ENGO150/WHY2/commit/2a09a38acf48f0e57beb5135ab7f1fdb18e088fa) | + +## Description + +Returns callback to `encryption_operation`, which is used during encryption/decryption for final string manipulation. \ No newline at end of file diff --git a/docs/functions/index.md b/docs/functions/index.md index a29ee76..08277c9 100644 --- a/docs/functions/index.md +++ b/docs/functions/index.md @@ -54,6 +54,7 @@ You can find documentation for every *public* function of WHY2 below. | [`why2_get_default_flags`](./core/flags/getters/why2_get_default_flags) | This generates why2_input_flags with default values | | [`why2_get_flags`](./core/flags/getters/why2_get_flags) | Returns used flags | | [`why2_no_output`](./core/flags/getters/why2_no_output) | Same as why2_get_default_flags() but for why2_output_flags | +| [`why2_get_encryption_operation`](./core/flags/getters/why2_get_encryption_operation) | Returns functions which is used for encryption & decryption | ## Logger