From 190280274e01bae4040d0848f011880e19b6e7ec Mon Sep 17 00:00:00 2001 From: ENGO150 Date: Sat, 25 Jan 2025 16:19:26 +0100 Subject: [PATCH] created doc for why2_get_flags --- .../core/flags/getters/why2_get_flags.md | 35 +++++++++++++++++++ docs/functions/index.md | 1 + 2 files changed, 36 insertions(+) create mode 100644 docs/functions/core/flags/getters/why2_get_flags.md diff --git a/docs/functions/core/flags/getters/why2_get_flags.md b/docs/functions/core/flags/getters/why2_get_flags.md new file mode 100644 index 0000000..1a3577a --- /dev/null +++ b/docs/functions/core/flags/getters/why2_get_flags.md @@ -0,0 +1,35 @@ + + +# why2_get_flags + +## Parameters + +*This functions doesn't take any parameters.* + +## Attributes + +| | | +| ------------------ | ------------------------------------------------------------------- | +| **Return type** | [`why2_input_flags`](../../../../types/core/flags/why2_input_flags) | +| **Header comment** | `RETURNS USED FLAGS` | +| **Added in commit** | [`692e76db175c2da444a5d92163305d26de73501a`](https://github.com/ENGO150/WHY2/commit/692e76db175c2da444a5d92163305d26de73501a) | + +## Description + +Returns used `input_flags` settings. \ No newline at end of file diff --git a/docs/functions/index.md b/docs/functions/index.md index 7a259e8..6225ac9 100644 --- a/docs/functions/index.md +++ b/docs/functions/index.md @@ -52,6 +52,7 @@ You can find documentation for every *public* function of WHY2 below. | [`why2_get_encryption_separator`](./core/flags/getters/why2_get_encryption_separator) | *This functions doesn't have any description.* | | [`why2_get_key_length`](./core/flags/getters/why2_get_key_length) | *This functions doesn't have any description.* | | [`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 | ## Logger