Class for the script_doc command. More...

Inheritance diagram for Blam::Console::ScriptDocCommand:

Public Member Functions
	ScriptDocCommand ()

	~ScriptDocCommand ()

CommandStatus	onCommand (std::vector< std::string > arguments)
	Called upon command execution. More...

Public Member Functions inherited from Blam::Console::ConsoleCommand
	ConsoleCommand ()
	Unused constructor. More...

	~ConsoleCommand ()
	Unused destructor. More...

Additional Inherited Members
Public Attributes inherited from Blam::Console::ConsoleCommand
std::string	name
	The name of the console command. More...

std::string	description
	An optional description of the command. Shown when using the `classify` command. More...

std::string	syntax
	The syntax information for the command. Shown to the user when using the `help` command with an argument. More...

std::vector< std::string >	aliases
	A list of aliases for the command. Executing any of these instead of the command name will behave the same. More...

CommandType	type
	The type of command this is. See Blam::Console::CommandType for more information. More...

Detailed Description

Class for the script_doc command.

Writes a file describing each command, script function, and global within a file.

Constructor & Destructor Documentation

Blam::Console::ScriptDocCommand::ScriptDocCommand ( )

inline

Blam::Console::ScriptDocCommand::~ScriptDocCommand ( )

inline

CommandStatus Blam::Console::ScriptDocCommand::onCommand ( std::vector< std::string > arguments )

inlinevirtual

Called upon command execution.

Parameters

arguments - The list of arguments passed to the command. Any space character in the command line is treated as a new argument.

Returns: The status of the command execution. See Blam::Console::CommandStatus for details.

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