Gromacs
2024.3
|
Provides functionality for formatting help text for console and reStructuredText.
This module provides helper functions and classes for formatting text to the console and as reStructuredText through a single interface. The main components of the module are:
The formatting syntax for strings accepted by this module is described in Help formatting. The module is currently exposed outside GROMACS only through this formatting syntax, not any API calls.
Classes | |
class | gmx::GlobalCommandLineHelpContext |
Helper for passing CommandLineHelpContext into parse_common_args(). More... | |
class | gmx::TextTableFormatter |
Formats rows of a table for text output. More... | |
class | gmx::HelpManager |
Helper for providing interactive online help. More... | |
class | gmx::AbstractSimpleHelpTopic |
Abstract base class for help topics that have simple text and no subtopics. More... | |
class | gmx::AbstractCompositeHelpTopic |
Abstract base class for help topics that have simple text and subtopics. More... | |
class | gmx::SimpleHelpTopic< HelpText > |
Template for simple implementation of AbstractSimpleHelpTopic. More... | |
class | gmx::CompositeHelpTopic< HelpText > |
Template for simple implementation of AbstractCompositeHelpTopic. More... | |
class | gmx::HelpLinks |
Hyperlink data for writing out help. More... | |
class | gmx::HelpWriterContext |
Context information for writing out help. More... | |
class | gmx::IHelpTopic |
Provides a single online help topic. More... | |
Directories | |
directory | onlinehelp |
Help Formatting for Online Help (onlinehelp) | |
directory | tests |
Unit tests for Help Formatting for Online Help (onlinehelp). | |
Files | |
file | helpformat.h |
Declares common string formatting routines for online help. | |
file | helpmanager.h |
Declares gmx::HelpManager. | |
file | helptopic.h |
Declares helper classes for implementing gmx::IHelpTopic. | |
file | helpwritercontext.h |
Declares gmx::HelpWriterContext. | |
file | ihelptopic.h |
Declares gmx::IHelpTopic. | |
file | mock_helptopic.h |
Declares mock implementation of gmx::IHelpTopic. | |