caffa::MethodInitHelper< MethodType > Class Template Reference

#include <cafMethodInitHelper.h>

Public Member Functions
	MethodInitHelper (MethodType &method, const std::string &keyword)
MethodInitHelper &	withDoc (const std::string &documentation)
	Apply documentation. More...
MethodInitHelper &	withArgumentNames (const std::vector< std::string > &argumentNames)
	Set argument names. Required for positional arguments. More...
MethodInitHelper &	makeConst ()
	Make the method a const method that cannot alter values Analoguous to a regular const object method. More...

Detailed Description

template<DerivesFromMethodHandle MethodType>
class caffa::MethodInitHelper< MethodType >

Helper class that is initialised with Object::initMethod and allows .. addding additional features to the Method.

Member Function Documentation

makeConst()

template<DerivesFromMethodHandle MethodType>

MethodInitHelper& caffa::MethodInitHelper< MethodType >::makeConst ( )

inline

Make the method a const method that cannot alter values Analoguous to a regular const object method.

Returns

MethodInitHelper&

withArgumentNames()

template<DerivesFromMethodHandle MethodType>

MethodInitHelper& caffa::MethodInitHelper< MethodType >::withArgumentNames ( const std::vector< std::string > &  argumentNames )

inline

Set argument names. Required for positional arguments.

Parameters

argumentNames

A list of argument names applied positionally.

Returns

MethodInitHelper&

withDoc()

template<DerivesFromMethodHandle MethodType>

MethodInitHelper& caffa::MethodInitHelper< MethodType >::withDoc ( const std::string &  documentation )

inline

Apply documentation.

Parameters

documentation

Returns

MethodInitHelper&

---

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

• Core/cafMethodInitHelper.h