Autodoc

This is a module.

See:

autodoc. data : integer

Module data.

autodoc. foo ( a : string , b? : string ) boolean ? , fn : fun ( a ? : string ) : integer | nil

Function foo.

Parameters :
  • a ( string ) – param a

  • b? ( string ) – param b

Returns :
  • _1? ( boolean ) – doc for boolean return

  • fn ( fun ( a ? : string ) : integer | nil ) – some function

class autodoc. Class

This is a class.

data : integer

Class attribute.

namespace

Class attribute with sub-items.

data : integer

Namespace attribute.

staticmethod stm ( )

Class staticmethod.

mth ( self : autodoc.Class )

Class method.

class autodoc. SubClass : autodoc.Class

This is a subclass.

class autodoc. ClassWithFields

This is a class with fields.

foo : integer ?

docs for foo

bar : string

docs for bar

alias autodoc. simpleAlias = integer

This is an alias.

data : integer

Alias attribute.

alias autodoc. aliasEnum = 1 | 2 | 3

This is an alias enum.