Gromacs  2020.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions
gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::IHelpExport Class Referenceabstract
+ Inheritance diagram for gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::IHelpExport:

Description

Callbacks for exporting help information for command-line modules.

Public Types

typedef
CommandLineModuleGroupData::ModuleList 
ModuleGroupContents
 Shorthand for a list of modules contained in a group.
 

Public Member Functions

virtual void startModuleExport ()=0
 Called once before exporting individual modules. More...
 
virtual void exportModuleHelp (const ICommandLineModule &module, const std::string &tag, const std::string &displayName)=0
 Called to export the help for each module. More...
 
virtual void finishModuleExport ()=0
 Called after all modules have been exported. More...
 
virtual void startModuleGroupExport ()=0
 Called once before exporting module groups. More...
 
virtual void exportModuleGroup (const char *title, const ModuleGroupContents &modules)=0
 Called to export the help for each module group. More...
 
virtual void finishModuleGroupExport ()=0
 Called after all module groups have been exported. More...
 
virtual void exportTopic (const IHelpTopic &topic)=0
 Called to export the help for a top-level topic. More...
 

Member Function Documentation

virtual void gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::IHelpExport::exportModuleGroup ( const char *  title,
const ModuleGroupContents modules 
)
pure virtual

Called to export the help for each module group.

Parameters
[in]titleTitle for the group.
[in]modulesList of modules in the group.

Implemented in gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportCompletion, and gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportReStructuredText.

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

Called to export the help for each module.

Parameters
[in]moduleModule for which the help should be exported.
[in]tagUnique tag for the module (gmx-something).
[in]displayNameDisplay name for the module (gmx something).

Implemented in gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportCompletion, and gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportReStructuredText.

virtual void gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::IHelpExport::exportTopic ( const IHelpTopic topic)
pure virtual

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

Parameters
[in]topicTopic to export.

Implemented in gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportCompletion, and gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportReStructuredText.

virtual void gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::IHelpExport::finishModuleExport ( )
pure virtual

Called after all modules have been exported.

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

Implemented in gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportCompletion, and gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportReStructuredText.

virtual void gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::IHelpExport::finishModuleGroupExport ( )
pure virtual

Called after all module groups have been exported.

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

Implemented in gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportCompletion, and gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportReStructuredText.

virtual void gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::IHelpExport::startModuleExport ( )
pure virtual

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.

Implemented in gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportCompletion, and gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportReStructuredText.

virtual void gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::IHelpExport::startModuleGroupExport ( )
pure virtual

Called once before exporting module groups.

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

Implemented in gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportCompletion, and gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportReStructuredText.


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