Gromacs
2023-beta
|
Help topic wrapper for a command-line module.
This class implements IHelpTopic such that it wraps a ICommandLineModule, allowing subcommand "help <command>" to produce the help for "<command>".
Public Member Functions | |
ModuleHelpTopic (const ICommandLineModule &module, const CommandLineHelpModuleImpl &helpModule) | |
Constructs a help topic for a specific module. | |
const char * | name () const override |
Returns the name of the topic. More... | |
const char * | title () const override |
Returns a title for the topic. More... | |
bool | hasSubTopics () const override |
Returns whether the topic has any subtopics. | |
const IHelpTopic * | findSubTopic (const char *) const override |
Finds a subtopic by name. More... | |
void | writeHelp (const HelpWriterContext &context) const override |
Prints the help text for this topic. More... | |
|
inlineoverridevirtual |
Finds a subtopic by name.
[in] | name | Name of subtopic to find. |
Implements gmx::IHelpTopic.
|
inlineoverridevirtual |
Returns the name of the topic.
This should be a single lowercase word, used to identify the topic. It is not used for the root of the help topic tree.
Implements gmx::IHelpTopic.
|
inlineoverridevirtual |
Returns a title for the topic.
May return NULL, in which case the topic is omitted from normal subtopic lists and no title is printed by the methods provided in helptopic.h.
Implements gmx::IHelpTopic.
|
overridevirtual |
Prints the help text for this topic.
[in] | context | Context object for writing the help. |
std::bad_alloc | if out of memory. |
FileIOError | on any I/O error. |
Implements gmx::IHelpTopic.