Documentation Language: Swift

Class

GIR.Thing

GIR named thing class

class Thing

Topics

Operators

?
==(_:_:)

Comparator to check whether two Things are equal

?
<(_:_:)

Comparator to check the ordering of two Things

Initializers

Instance Properties

V
comment

documentation for the Thing

V
deprecated

Alternative to use if deprecated

V
disguised

Is this Thing disguised?

V
escapedName

return a name with reserved Ref or Protocol suffixes escaped

V
introspectable

Is this Thing introspectable?

V
kind

String representation of the kind of Thing represented by the receiver

V
markedAsDeprecated

Is this Thing explicitly marked as deprecated?

V
name

type name without namespace/prefix

V
swiftCamelCASEName

Return an idiomatic, de-uppercased Swift name.

V
swiftCamelCaseName

Return an idiomatic Swift name.

V
version

Version the receiver is available from

Instance Methods

F
hash(into:)

Hashes the essential components of this value by feeding them into the given hasher.

Default Implementations

Relationships

Inherited By

Conforms To

See Also

GIR element models

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.Method

data type representing a function/method

C
GIR.Property

a property is a C type

C
GIR.Record

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