From e5750321da8fd1e739d2fee53b4e805ab559be31 Mon Sep 17 00:00:00 2001 From: ENGO150 Date: Sat, 25 Jan 2025 18:17:53 +0100 Subject: [PATCH] created doc for why2_set_key_length --- .../core/flags/setters/why2_set_key_length.md | 37 +++++++++++++++++++ docs/functions/index.md | 1 + 2 files changed, 38 insertions(+) create mode 100644 docs/functions/core/flags/setters/why2_set_key_length.md diff --git a/docs/functions/core/flags/setters/why2_set_key_length.md b/docs/functions/core/flags/setters/why2_set_key_length.md new file mode 100644 index 0000000..743847a --- /dev/null +++ b/docs/functions/core/flags/setters/why2_set_key_length.md @@ -0,0 +1,37 @@ + + +# why2_set_key_length + +## Parameters + +| Identifier | Data type | +| -------------- | --------- | +| `keyLengthNew` | `int` | + +## Attributes + +| | | +| ------------------ | ---------------------------------------------- | +| **Return type** | `void` | +| **Header comment** | *This functions doesn't have any description.* | +| **Added in commit** | [`2156aff370d8a223ff41882467d55ceb41d4f877`](https://github.com/ENGO150/WHY2/commit/2156aff370d8a223ff41882467d55ceb41d4f877) | + +## Description + +Sets `key_length`, which is used in `key` generation. Also works as minimal length of `key` passed in [`why2_encrypt_text`](../../../encrypter/why2_encrypt_text). \ No newline at end of file diff --git a/docs/functions/index.md b/docs/functions/index.md index 639da03..0f8456e 100644 --- a/docs/functions/index.md +++ b/docs/functions/index.md @@ -65,6 +65,7 @@ You can find documentation for every *public* function of WHY2 below. | Function | Description | | --------------------------------------------------------------------- | ------------------------------------------------- | | [`why2_set_encryption_separator`](./core/flags/setters/why2_set_encryption_separator) | *This functions doesn't have any description.* | +| [`why2_set_key_length`](./core/flags/setters/why2_set_key_length) | *This functions doesn't have any description.* | ## Logger