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

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

Description

Implements export for command-line completion.

Public Member Functions
	HelpExportCompletion (const CommandLineHelpModuleImpl &helpModule)
	Initializes completion exporter.

void	startModuleExport () override
	Called once before exporting individual modules. More...

void	exportModuleHelp (const ICommandLineModule &module, const std::string &tag, const std::string &displayName) override
	Called to export the help for each module. More...

void	finishModuleExport () override
	Called after all modules have been exported. More...

void	startModuleGroupExport () override
	Called once before exporting module groups. More...

void	exportModuleGroup (const char *, const ModuleGroupContents &) override
	Called to export the help for each module group. More...

void	finishModuleGroupExport () override
	Called after all module groups have been exported. More...

void	exportTopic (const IHelpTopic &) override
	Called to export the help for a top-level topic. More...

Additional Inherited Members
Public Types inherited from gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::IHelpExport
typedef CommandLineModuleGroupData::ModuleList	ModuleGroupContents
	Shorthand for a list of modules contained in a group.

Member Function Documentation

void gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportCompletion::exportModuleGroup	(	const char *	title,
		const ModuleGroupContents &	modules
	)

inlineoverridevirtual

Called to export the help for each module group.

Parameters

[in]	title	Title for the group.
[in]	modules	List of modules in the group.

Implements gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::IHelpExport.

void gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportCompletion::exportModuleHelp	(	const ICommandLineModule &	module,
		const std::string &	tag,
		const std::string &	displayName
	)

overridevirtual

Called to export the help for each module.

Parameters

[in]	module	Module for which the help should be exported.
[in]	tag	Unique tag for the module (gmx-something).
[in]	displayName	Display name for the module (gmx something).

Implements gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::IHelpExport.

void gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportCompletion::exportTopic ( const IHelpTopic & topic )

inlineoverridevirtual

Called to export the help for a top-level topic.

Parameters

[in] topic Topic to export.

Implements gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::IHelpExport.

void gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportCompletion::finishModuleExport ( )

overridevirtual

Called after all modules have been exported.

Can close files opened in startModuleExport(), write footers to them etc.

Implements gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::IHelpExport.

void gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportCompletion::finishModuleGroupExport ( )

inlineoverridevirtual

Called after all module groups have been exported.

Can close files opened in startModuleGroupExport(), write footers to them etc.

Implements gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::IHelpExport.

void gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportCompletion::startModuleExport ( )

overridevirtual

Called once before exporting individual modules.

Can, e.g., open shared output files (e.g., if the output is written into a single file, or if a separate index is required) and write headers into them.

Implements gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::IHelpExport.

void gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportCompletion::startModuleGroupExport ( )

inlineoverridevirtual

Called once before exporting module groups.

Can, e.g., open a single output file for listing all the groups.

Implements gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::IHelpExport.

The documentation for this class was generated from the following file:

src/gromacs/commandline/cmdlinehelpmodule.cpp

Description

Public Member Functions

Additional Inherited Members

Member Function Documentation