Gromacs  2026.0-dev-20241204-d69d709
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
gmx::anonymous_namespace{helpwritercontext.cpp}::WrapperToString Class Reference
+ Inheritance diagram for gmx::anonymous_namespace{helpwritercontext.cpp}::WrapperToString:
+ Collaboration diagram for gmx::anonymous_namespace{helpwritercontext.cpp}::WrapperToString:

Description

Wraps markup output into a single string.

Public Member Functions

 WrapperToString (const TextLineWrapperSettings &settings)
 Creates a wrapper with the given settings.
 
TextLineWrapperSettingssettings () override
 Provides the wrapping settings. More...
 
void wrap (const std::string &text) override
 Appends the given string to output.
 
const std::string & result () const
 Returns the result string.
 

Member Function Documentation

TextLineWrapperSettings& gmx::anonymous_namespace{helpwritercontext.cpp}::WrapperToString::settings ( )
inlineoverridevirtual

Provides the wrapping settings.

HelpWriterContext::Impl::processMarkup() may provide some default values for the settings if they are not set; this is the reason the return value is not const.

Implements gmx::anonymous_namespace{helpwritercontext.cpp}::IWrapper.


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