carb::options::printOptionUsage¶
Defined in carb/extras/Options.h
-
inline void
carb::options
::
printOptionUsage
(const Option *supportedArgs, const char *helpString, FILE *stream)¶ Prints out the documentation for an option table.
- Parameters
supportedArgs – [in] The table of options that this program can parse. This table must be terminated by an empty entry in the list (ie: all values
nullptr
or0
). This may not be nullptr. The documentation for each of the options in this table will be written out to the selected stream.helpString – [in] The help string describing this program, its command line syntax, and its commands. This should not include any documentation for the supported options.
stream – [in] The stream to output the documentation to. This may not be
nullptr
.
- Returns
No return value.