Directives¶

Type Targets¶

alias T = integer¶

alias mod.T = integer¶

Data¶

simpleData¶: Description

dataWithTypeColon: T¶: Description

dataWithTypeEq: T¶: Description

dataWithType: T¶: Description

dataWithBrokenType: UnknownType¶: Description

dataWithNestedType: mod.T¶: Description

const simpleConst¶: Description

simpleAttribute¶: Description

Function¶

simpleFunction()¶: Description

functionWithEmptyParams()¶: Description

functionWithParams(a, b, c)¶: Description

functionWithTypedParams(T: integer, b: table<T, mod.T>, c: fun(T: T, ...): (T: T, ...))¶: Description

functionWithReturn() → integer¶: Description

functionWithReturnAndParams(a: integer) → integer¶: Description

functionWithComplexReturnType() → a: table<string, string>, ...: fun(a: integer, ...): (a: integer, ...)¶: Description

functionWithOptionalTypes(x?: integer) → y?: integer¶

Parameters:: x? (integer) – Description
Returns:: y? (integer) – Description

simpleMethod()¶: Description

classmethod simpleClassmethod()¶: Description

staticmethod simpleStaticmethod()¶: Description

Class¶

class simpleClass¶: Description

class classWithBase : T¶: Description

class classWithSeveralBases : T, mod.T, {[string]: UnknownType}¶: Description

class classWithMembers¶

classData¶

classFunction()¶

Alias¶

alias simpleAlias¶

alias aliasWithTypeColon = T¶

alias aliasWithTypeEq = T¶

alias aliasWithType = T¶

alias aliasWithMembers¶

aliasData¶

aliasFunction()¶