function_simple ( ) ¶

Description

function_no_args_parens ( ) ¶

Description

function_untyped_args ( a , b , c ) ¶

Description

function_typed_args ( a :


    
     integer

, b :


    
     string

) ¶

Description

function_typed_optional_args ( a? :


    
     integer

) ¶

Description

function_typed_args_crossrefs ( T :


    
     integer

, b :

) ¶

Description

function_return_type ( ) :


    
     integer

¶

Description

function_return_types ( ) :


    
     integer

,


    
     boolean

¶

Description

function_optional_return_types ( ) :


    
     integer

? ¶

Description

function_named_return_types ( ) : ( a :


    
     integer

, b :


    
     boolean

) ¶

Description

function_named_optional_return_types ( ) : ( a? :


    
     integer

) ¶

Description

function_return_types_crossrefs ( ) : ( T :


    
     string

, a :

) ¶

Description

function_generics < T > ( ) ¶

Description

function_generics_return < T > ( ) :

[ ] ¶

Description

function_generics_args_and_return < T > ( ... :

) :

[ ] ¶

Description

function_complex_types (
T :


    
     integer

,
b :


    
     table

<

,


     
      target_module.T

> ,
c : fun ( T :

, ... ) : ( T :

, ... )
) : (
a :


    
     table

<


    
     string

,


    
     string

> ,
... : fun ( a :


    
     integer

, ... ) : ( a :


    
     integer

, ... )
) ¶

Description

function_complex_types (
T :


    
     integer

,
b :


    
     table

<

,


     
      target_module.T

> ,
c : fun ( T :

, ... ) : ( T :

, ... )
) : (
a :


    
     table

<


    
     string

,


    
     string

> ,
... : fun ( a :


    
     integer

, ... ) : ( a :


    
     integer

, ... )
) ¶

Description

function_param_return_doc ( x :


    
     integer

, y? :

) : ( a :


    
     integer

, b? :

) ¶

Parameters :

x ( integer ) – Description x
y? ( T ) – Description y

Returns :

a ( integer ) – Description b
b? ( T ) – Description b

method ( ) ¶

Description

cls:method_outside_of_class ( ) ¶

Description

classmethod classmethod ( ) ¶

Description

classmethod cls:classmethod_outside_of_class ( ) ¶

Description

staticmethod staticmethod ( ) ¶

Description

staticmethod cls.staticmethod_outside_of_class ( ) ¶

Description

data_simple ¶

Description

data_type_colon :

¶

Description

data_type_eq =

¶

Description

data_type.T ¶

Description

data_type_broken :


    
     UnknownType

¶

Description

data_type_nested :


     
      target_module.T

¶

Description

attribute ¶

Description

cls.attribute_outside_of_class ¶

Description

class class_simple ¶

Description

class class_one_base :

¶

Description

class class_multiple_bases :

,


     
      target_module.T

, { [


    
     string

] :


    
     UnknownType

} ¶

Description

class class_generic < T > ¶

Description

class class_generic_multiple_types < U , V > ¶

Description

class class_generic_with_base < T > :

[ ] ¶

Description

class class_members ¶

class_data ¶

class_function ( ) ¶

class_method ( ) ¶

class ctor class_ctor ( a :

) ¶

class class_bases_and_ctor :

¶

class ctor class_bases_and_ctor ( a :

)

alias alias_simple ¶

alias alias_type_colon =

¶

alias alias_type_eq =

¶

alias alias_type.T ¶

alias alias_generic < T > =

[ ] ¶

alias alias_strings = "a|b" | "c" | "d" ¶

alias alias_members ¶

alias_data ¶

alias_function ( ) ¶

alias_method ( ) ¶

enum enum_simple ¶

enum enum_generic < T > ¶

enum enum_members ¶

enum_data ¶

enum_function ( ) ¶

enum_method ( ) ¶

table_simple ¶

table_members ¶

table_data ¶

table_function ( ) ¶

table_method ( ) ¶