leonetienne/Hazelnupp
1
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

Readme

Browse Source
This commit is contained in:
Leonetienne 2021-06-04 02:43:38 +02:00
parent 2a9e2f2459
commit 8779514d3f
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
readme.md
View File

@ -240,7 +240,7 @@ args.RegisterConstraints({pc});
What doesn't work is inserting multiple constraints for one key. It will just discard the oldest one. But that's okay because one can describe all possible constraints for a single key in **one** struct.
## Automatic parameter documentation
Hazelnupp does create an automatic parameter documentation accessible via `--help`.
Hazelnupp does automatically create a parameter documentation, accessible via `--help`.
If you want to use `--help` yourself, just turn it off.
```cpp
Hazelnupp args;
@ -281,7 +281,7 @@ Hazelnupp args;
args.SetBriefDescription("This is the testing application for Hazelnupp.");
```
If you want to display this information somewhere else, you can always access it via `args.GenerateDocumentation()`.
If you want to display this information somewhere else, you can always access it as a string via `args.GenerateDocumentation()`.
## More examples?
Check out the unit tests! They may help you out!