Documentation Language: Swift

Class

GIR.Method

data type representing a function/method

class Method

Topics

Initializers

?
init(node:at:)

Initialiser to construct a method type from XML

Instance Properties

V
args

All associated arguments (parameters) in order

V
isBareFactory

is this a bare factory method that is not the default constructor

V
isGetter

indicate whether this is a getter method

V
isRef

indicate whether this is a ref method

V
isSetter

indicate whether this is a setter method

V
isUnref

indicate whether this is an unref method

V
kind

String representation of member Methods

V
returns

Return type

V
throwsError

true if this method throws an error

Instance Methods

F
isConstructorOf(_:)

return whether the method is a constructor of the given record

F
isFactoryOf(_:)

return whether the method is a factory of the given record

F
isGetterFor(setter:)

indicate whether this is a getter method for the given setter

F
isSetterFor(getter:)

indicate whether this is a setter method for the given getter

Relationships

Inherits From

Inherited By

Conforms To

See Also

GIR element models

C
GIR.Thing

GIR named thing class

C
GIR.Datatype

GIR type class

C
GIR.CType

a type with an underlying C type entry

C
GIR.Alias

a type alias is just a type with an underlying C type

C
GIR.Argument

data type representing a function/method argument or return type

C
GIR.Bitfield

a bitfield is defined akin to an enumeration

C
GIR.Callback

a callback is the same as a function, except that the type definition is a @convention(c) callback definition

C
GIR.Class

a class data type record

C
GIR.Constant

an entry for a constant

C
GIR.Enumeration

an enumeration entry

C
GIR.Field

a field is a Property

C
GIR.Function

a function is the same as a method

C
GIR.Interface

an inteface is similar to a class, but can be part of a more complex type graph

C
GIR.Property

a property is a C type

C
GIR.Record

a data type record to create a protocol/struct/class for