#include <gromacs/commandline/cmdlinehelpwriter.h>

Description

Writes help information for Options.

Public Member Functions
	CommandLineHelpWriter (const Options &options)
	Creates an object that writer ascii-formatted help for Options. More...

CommandLineHelpWriter &	setHelpText (const std::string &help)
	Sets the help text to print as description. More...

CommandLineHelpWriter &	setHelpText (const ArrayRef< const char *const > &help)
	Sets the help text to print as description. More...

CommandLineHelpWriter &	setKnownIssues (const ArrayRef< const char *const > &bugs)
	Sets the list of known bugs/limitations. More...

CommandLineHelpWriter &	setKnownIssues (ArrayRef< const std::string > bug)
	Sets text for known bugs. More...

void	writeHelp (const CommandLineHelpContext &context)
	Writes the help. More...

Constructor & Destructor Documentation

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.

CommandLineHelpWriter & gmx::CommandLineHelpWriter::setHelpText ( const std::string & help )

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.

CommandLineHelpWriter & gmx::CommandLineHelpWriter::setHelpText ( const ArrayRef< const char *const > & help )

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.

CommandLineHelpWriter & gmx::CommandLineHelpWriter::setKnownIssues ( const ArrayRef< const char *const > & bugs )

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.

CommandLineHelpWriter & gmx::CommandLineHelpWriter::setKnownIssues ( ArrayRef< const std::string > bug )

Sets text for known bugs.

Parameters

[in] bug Text for bugs to show.

Exceptions

std::bad_alloc if out of memory.

Formatting for the text is described on Help formatting.

void gmx::CommandLineHelpWriter::writeHelp ( const CommandLineHelpContext & context )

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: