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

Description

Implements export for web pages as reStructuredText.

Public Member Functions

 HelpExportReStructuredText (const CommandLineHelpModuleImpl &helpModule, IFileOutputRedirector *outputRedirector)
 Initializes reST 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 *title, const ModuleGroupContents &modules) 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 &topic) 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}::HelpExportReStructuredText::exportModuleGroup ( const char *  title,
const ModuleGroupContents modules 
)
overridevirtual

Called to export the help for each module group.

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

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

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

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).

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

void gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportReStructuredText::exportTopic ( const IHelpTopic topic)
overridevirtual

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

Parameters
[in]topicTopic to export.

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

void gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportReStructuredText::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}::HelpExportReStructuredText::finishModuleGroupExport ( )
overridevirtual

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}::HelpExportReStructuredText::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}::HelpExportReStructuredText::startModuleGroupExport ( )
overridevirtual

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: