created doc for why2_no_output

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

View File

@ -0,0 +1,37 @@
<!--
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_no_output
## Parameters
| Identifier | Data type |
| ----------- | ---------------------------------------------------------------------- |
| `exit_code` | [`enum WHY2_EXIT_CODES`](../../../../enums/core/flags/why2_exit_codes) |
## Attributes
| | |
| ------------------ | --------------------------------------------------------------------- |
| **Return type** | [`why2_output_flags`](../../../../types/core/flags/why2_output_flags) |
| **Header comment** | `SAME AS why2_get_default_flags() BUT FOR why2_output_flags` |
| **Added in commit** | [`c5de589fff870bbd8cf428465ea4e73caa3e8b38`](https://github.com/ENGO150/WHY2/commit/c5de589fff870bbd8cf428465ea4e73caa3e8b38) |
## Description
Returns empty `output_flags` with `exit_code`.

View File

@ -53,6 +53,7 @@ You can find documentation for every *public* function of WHY2 below.
| [`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 | | [`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_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 |
## Logger ## Logger