cmdlinehelpmodule.cpp File Reference

#include "gmxpre.h"
#include "cmdlinehelpmodule.h"
#include <cstdio>
#include <cstring>
#include <filesystem>
#include <map>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "gromacs/commandline/cmdlinehelpcontext.h"
#include "gromacs/commandline/cmdlinehelpwriter.h"
#include "gromacs/commandline/cmdlinemodulemanager_impl.h"
#include "gromacs/commandline/cmdlineparser.h"
#include "gromacs/onlinehelp/helpformat.h"
#include "gromacs/onlinehelp/helpmanager.h"
#include "gromacs/onlinehelp/helptopic.h"
#include "gromacs/onlinehelp/helpwritercontext.h"
#include "gromacs/options/basicoptions.h"
#include "gromacs/options/options.h"
#include "gromacs/utility/arrayref.h"
#include "gromacs/utility/baseversion.h"
#include "gromacs/utility/classhelpers.h"
#include "gromacs/utility/exceptions.h"
#include "gromacs/utility/fileredirector.h"
#include "gromacs/utility/gmxassert.h"
#include "gromacs/utility/path.h"
#include "gromacs/utility/programcontext.h"
#include "gromacs/utility/stringstream.h"
#include "gromacs/utility/stringutil.h"
#include "gromacs/utility/textreader.h"
#include "gromacs/utility/textstream.h"
#include "gromacs/utility/textwriter.h"
#include "shellcompletions.h"

Include dependency graph for cmdlinehelpmodule.cpp:

Description

Implements gmx::CommandLineHelpModule.

Author

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

Classes
class	gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::RootHelpTopic
	Help topic that forms the root of the help tree for the help subcommand. More...
class	gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::IHelpExport
	Callbacks for exporting help information for command-line modules. More...
class	gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::CommandsHelpTopic
	Help topic for listing the commands. More...
class	gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::ModuleHelpTopic
	Help topic wrapper for a command-line module. More...
class	gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportReStructuredText
	Implements export for web pages as reStructuredText. More...
class	gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::HelpExportCompletion
	Implements export for command-line completion. More...

Functions
void	gmx::anonymous_namespace{cmdlinehelpmodule.cpp}::initProgramLinks (HelpLinks *links, const CommandLineHelpModuleImpl &helpModule)
	Adds hyperlinks to modules within this binary. More...