luadoc

package module

v0.3.2 Latest Latest Go to latest Published: May 14, 2024 License: Unlicense Imports: 5 Imported by: 26

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/luevano/gopher-luadoc

Links

Open Source Insights

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
type Method
type Param
- func (p *Param) String() string
type Var

Constants ¶

View Source

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

Variables ¶

This section is empty.

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
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL