Class Method (version 0.18)

Description: The interface to a method declaration

Class overview

Index

Method Overview

[const] yield const ref ArgType each_argument	Iterate over all arguments of this method
[const] const ref ArgType ret_type	The return type of this method
[const] bool is_const?	True, if this method does not alter the object
[const] bool is_static?	True, if this method is static (a class method)
[const] string name	The name of the class
[const] string doc	The documentation string for this method
destroy	Explicitly destroy the object
[const] bool destroyed	Tell, if the object was destroyed

destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

[const] bool destroyed

Description: Tell, if the object was destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] string doc

Description: The documentation string for this method

[const] yield const ref ArgType each_argument

Description: Iterate over all arguments of this method

[const] bool is_const?

Description: True, if this method does not alter the object

[const] bool is_static?

Description: True, if this method is static (a class method)

[const] string name

Description: The name of the class

[const] const ref ArgType ret_type

Description: The return type of this method