luadoc

README

gopher-luadoc

WIP

The API is not stable and may change at any time. No documentation for now...

Self-documenting gopher-lua framework for libraries.

Note: This is a fork of mangalorg/gopher-luadoc.

Documentation

Index

• Constants
• func Enum(members ...string) string
• func List(of string) string
• func Map(keys string, values string) string
• func TableLiteral(keysAndValues ...string) string
• type Class
• type Func
  • func (f Func) AsType() string
• type Lib
  • func (l *Lib) Loader() lua.LGFunction
  • func (l *Lib) LuaDoc() string
  • func (l *Lib) Value(state *lua.LState) *lua.LTable
• type Method
• type Param
  • func (p *Param) String() string
• type Var

Constants

const (
	String  = "string"
	Number  = "number"
	Boolean = "boolean"
	Table   = "table"
	Any     = "any"
)

Functions

func Enum

func Enum(members ...string) string

func List

func List(of string) string

func Map

func Map(keys string, values string) string

func TableLiteral

func TableLiteral(keysAndValues ...string) string

Types

type Class

type Class struct {
	Name        string
	Description string
	Methods     []*Method
}

type Func

type Func struct {
	Name        string
	Description string
	Value       lua.LGFunction
	Generics    []string
	Params      []*Param
	Returns     []*Param
}

func (Func) AsType

func (f Func) AsType() string

type Lib

type Lib struct {
	Name        string
	Description string
	Vars        []*Var
	Funcs       []*Func
	Classes     []*Class
	Libs        []*Lib
}

func (*Lib) Loader

func (l *Lib) Loader() lua.LGFunction

func (*Lib) LuaDoc

func (l *Lib) LuaDoc() string

func (*Lib) Value

func (l *Lib) Value(state *lua.LState) *lua.LTable

type Method

type Method struct {
	Name        string
	Description string
	Value       lua.LGFunction
	Generics    []string
	Params      []*Param
	Returns     []*Param
}

type Param

type Param struct {
	Name        string
	Description string
	Type        string
	Optional    bool
}

func (*Param) String

func (p *Param) String() string

type Var

type Var struct {
	Name        string
	Description string
	Value       lua.LValue
	Type        string
}