cmdlinehelpwriter.cpp File Reference

#include "gmxpre.h"
#include "cmdlinehelpwriter.h"
#include <cstring>
#include <algorithm>
#include <string>
#include "gromacs/commandline/cmdlinehelpcontext.h"
#include "gromacs/onlinehelp/helpwritercontext.h"
#include "gromacs/options/basicoptions.h"
#include "gromacs/options/filenameoption.h"
#include "gromacs/options/options.h"
#include "gromacs/options/optionsvisitor.h"
#include "gromacs/options/timeunitmanager.h"
#include "gromacs/utility/arrayref.h"
#include "gromacs/utility/exceptions.h"
#include "gromacs/utility/stringutil.h"
#include "gromacs/utility/textwriter.h"
#include "shellcompletions.h"

Include dependency graph for cmdlinehelpwriter.cpp:

Description

Implements gmx::CommandLineHelpWriter.

Author

Teemu Murtola teemu.nosp@m..mur.nosp@m.tola@.nosp@m.gmai.nosp@m.l.com

Classes
class	gmx::anonymous_namespace{cmdlinehelpwriter.cpp}::IOptionsFormatter
	Interface for output format specific formatting of options. More...
class	gmx::anonymous_namespace{cmdlinehelpwriter.cpp}::OptionsFilter
	Output format independent processing of options. More...
class	gmx::anonymous_namespace{cmdlinehelpwriter.cpp}::SynopsisFormatter
	Formatter implementation for synopsis. More...
class	gmx::anonymous_namespace{cmdlinehelpwriter.cpp}::OptionsListFormatter
	Formatter implementation for help export. More...
class	gmx::CommandLineHelpWriter::Impl
	Private implementation class for CommandLineHelpWriter. More...

Functions
void	gmx::anonymous_namespace{cmdlinehelpwriter.cpp}::formatOptionNameAndValue (const OptionInfo &option, std::string *name, std::string *value)
	Formats option name and value.
std::string	gmx::anonymous_namespace{cmdlinehelpwriter.cpp}::defaultOptionValue (const OptionInfo &option)
	Formats the default option value as a string.
std::string	gmx::anonymous_namespace{cmdlinehelpwriter.cpp}::fileOptionFlagsAsString (const FileNameOptionInfo &option, bool bAbbrev)
	Formats the flags for a file option as a string.
std::string	gmx::anonymous_namespace{cmdlinehelpwriter.cpp}::descriptionWithOptionDetails (const CommonFormatterData &common, const OptionInfo &option)
	Formats the description for an option as a string.