#include <gromacs/commandline/cmdlinehelpwriter.h>
Writes help information for Options.
gmx::CommandLineHelpWriter::CommandLineHelpWriter |
( |
const Options & |
options | ) |
|
|
explicit |
Creates an object that writer ascii-formatted help for Options.
- Parameters
-
[in] | options | Options for which help should be printed. |
Sets the help text to print as description.
- Parameters
-
[in] | help | Help text to show. |
- Exceptions
-
std::bad_alloc | if out of memory. |
If help
is empty, or this method is not called, only a list of options is printed. Formatting for the help text is described on Help formatting.
Sets the help text to print as description.
- Parameters
-
[in] | help | Help text to show. |
- Exceptions
-
std::bad_alloc | if out of memory. |
If help
is empty, or this method is not called, only a list of options is printed. Formatting for the help text is described on Help formatting.
Sets the list of known bugs/limitations.
- Parameters
-
[in] | bugs | Array of bugs/limitations. |
Each entry in the input array identifies a separate issue. The array passed should remain valid for the lifetime of the writer object.
Writes the help.
- Parameters
-
[in] | context | Context object for writing the help. |
- Exceptions
-
std::bad_alloc | if out of memory. |
FileIOError | on any I/O error. |
The documentation for this class was generated from the following files: