Inheritance diagram for gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::ModuleHelpTopic:

Collaboration diagram for gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::ModuleHelpTopic:

Description

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.

virtual const char *	name () const
	Returns the name of the topic. More...

virtual const char *	title () const
	Returns a title for the topic. More...

virtual bool	hasSubTopics () const
	Returns whether the topic has any subtopics.

virtual const IHelpTopic *	findSubTopic (const char *) const
	Finds a subtopic by name. More...

virtual void	writeHelp (const HelpWriterContext &context) const
	Prints the help text for this topic. More...

Member Function Documentation

virtual const IHelpTopic* gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::ModuleHelpTopic::findSubTopic ( const char * name ) const

inlinevirtual

Finds a subtopic by name.

Parameters

[in] name Name of subtopic to find.

Returns: Pointer to the found subtopic, or NULL if matching topic is not found.

virtual const char* gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::ModuleHelpTopic::name ( ) const

inlinevirtual

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.

virtual const char* gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::ModuleHelpTopic::title ( ) const

inlinevirtual

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.

void gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::ModuleHelpTopic::writeHelp ( const HelpWriterContext & context ) const

virtual

Prints the help text for this topic.

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 file: