ENGO150/WHY2-docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

created doc for why2_get_default_flags

Browse Source 
the documentation is starting to drive me crazy fr
This commit is contained in:
Václav Šmejkal 2025-01-25 16:15:54 +01:00
parent 8adaadb8d4
commit 074f7afe1e
Signed by: ENGO150
GPG Key ID: 4A57E86482968843
2 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/functions/core/flags/getters/why2_get_default_flags.md Normal file
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_default_flags
## Parameters
*This functions doesn't take any parameters.*
## Attributes
| | |
| ------------------ | ------------------------------------------------------------------- |
| **Return type** | [`why2_input_flags`](../../../../types/core/flags/why2_input_flags) |
| **Header comment** | `THIS GENERATES why2_input_flags WITH DEFAULT VALUES` |
| **Added in commit** | [`71865826fa159e4480ecd676ff224822ea640506`](https://github.com/ENGO150/WHY2/commit/71865826fa159e4480ecd676ff224822ea640506) |
## Description
Returns default `input_flags` settings.

1
docs/functions/index.md
View File

@ -51,6 +51,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_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_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 |
## Logger ## Logger