-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added missing output function documentation
- Loading branch information
Showing
3 changed files
with
37 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
title: cag_option_print | ||
description: Prints all options to the terminal. | ||
--- | ||
|
||
_(since v1.0.0)_ | ||
description: Prints all options to the terminal. | ||
|
||
## Description | ||
```c | ||
void cag_option_print(const cag_option *options, size_t option_count, | ||
FILE *destination); | ||
``` | ||
This function prints all options to the terminal. This can be used to generate | ||
the output for a "--help" option. | ||
## Parameters | ||
* **options**: The options which will be printed. | ||
* **option_count**: The option count which will be printed. | ||
* **destination**: The destination where the output will be printed. | ||
## Changelog | ||
| Version | Description | | ||
|------------|--------------------------------------------------------| | ||
| **v1.0.0** | The function is introduced. | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters