created doc for why2_get_flags

This commit is contained in:
Václav Šmejkal 2025-01-25 16:19:26 +01:00
parent 074f7afe1e
commit 190280274e
Signed by: ENGO150
GPG Key ID: 4A57E86482968843
2 changed files with 36 additions and 0 deletions

View File

@ -0,0 +1,35 @@
<!--
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_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.

View File

@ -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