HoverRace::Script::Help::Method Class Reference

API documentation for a Lua method. More...

#include <Method.h>

Inheritance diagram for HoverRace::Script::Help::Method:

Public Types
using	examples_t = std::vector< std::string >
using	sigs_t = std::vector< std::string >

Public Member Functions
	Method (const std::string &name)
	Constructor. More...
virtual	~Method ()
const std::string &	GetBrief () const
const std::string &	GetDesc () const
const std::string &	GetName () const
const sigs_t &	GetSigs () const
virtual void	Load (Util::yaml::MapNode *node)

Protected Member Functions
sigs_t &	GetSigs ()
void	SetBrief (const std::string &s)
void	SetDesc (const std::string &s)

Private Member Functions
	Method ()=delete

Private Attributes
std::string	brief
std::string	desc
examples_t	examples
std::string	name
sigs_t	sigs

Detailed Description

API documentation for a Lua method.

Author

Michael Imamura

Member Typedef Documentation

using HoverRace::Script::Help::Method::examples_t = std::vector<std::string>

using HoverRace::Script::Help::Method::sigs_t = std::vector<std::string>

Constructor & Destructor Documentation

HoverRace::Script::Help::Method::Method ( )

privatedelete

HoverRace::Script::Help::Method::Method

(

const std::string &

name

)

Constructor.

Parameters

name	The name of the method.

virtual HoverRace::Script::Help::Method::~Method ( )

inlinevirtual

Member Function Documentation

const std::string& HoverRace::Script::Help::Method::GetBrief ( ) const

inline

const std::string& HoverRace::Script::Help::Method::GetDesc ( ) const

inline

const std::string& HoverRace::Script::Help::Method::GetName ( ) const

inline

sigs_t& HoverRace::Script::Help::Method::GetSigs ( )

inlineprotected

const sigs_t& HoverRace::Script::Help::Method::GetSigs ( ) const

inline

void HoverRace::Script::Help::Method::Load ( Util::yaml::MapNode *  node )

virtual

Reimplemented in HoverRace::Script::Help::Event.

void HoverRace::Script::Help::Method::SetBrief ( const std::string &  s )

protected

void HoverRace::Script::Help::Method::SetDesc ( const std::string &  s )

protected

Member Data Documentation

std::string HoverRace::Script::Help::Method::brief

private

std::string HoverRace::Script::Help::Method::desc

private

examples_t HoverRace::Script::Help::Method::examples

private

std::string HoverRace::Script::Help::Method::name

private

sigs_t HoverRace::Script::Help::Method::sigs

private

---

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

• Method.h
• Method.cpp