HelpCommand Class Reference

Class for the Help command. More...

#include <HelpCommand.hpp>

Inheritance diagram for HelpCommand:

Collaboration diagram for HelpCommand:

Public Member Functions
	HelpCommand ()
void	SetApplicationLabelName (std::string name)
	Updates the application name label. More...
int	execute (std::vector< std::string > args)
	Executes the command. More...
Public Member Functions inherited from ToolCommand
std::string	GetCommandName ()
	Retrieves the name of the command. More...
std::string	GetSyntax ()
	Retrieves the syntax of the command. More...
std::string	GetDescription ()
	Retrieves the description of the command. More...

Additional Inherited Members
Protected Attributes inherited from ToolCommand
std::string	command = ""
	The name of the command. More...
std::string	syntax = ""
	The syntax of the command. This should include the command name, as well as any arguments. More...
std::string	description = ""
	A description of the command. More...

Detailed Description

Class for the Help command.

This command provides a list of all available Tool commands, along with their syntax and description.

Constructor & Destructor Documentation

HelpCommand()

HelpCommand::HelpCommand ( )

inline

Member Function Documentation

execute()

int HelpCommand::execute ( std::vector< std::string >  args )

inlinevirtual

Executes the command.

Parameters

args	- A list of arguments provided to the command.

Returns

The command execution result. Will return 0 if the command completed successfully. If an error occurred, this will usually return a negative number.

Reimplemented from ToolCommand.

Here is the call graph for this function:

Here is the caller graph for this function:

SetApplicationLabelName()

void HelpCommand::SetApplicationLabelName ( std::string  name )

inline

Updates the application name label.

This should be called in cases where the application name is something other than tool.exe.

Parameters

name	- The name of the application, without the file extension.

Here is the caller graph for this function:

---

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

• HEKTool/components/console/commands/HelpCommand.hpp