ludoc

Documentation

Index

• type Category
• type Docs
  • func New() *Docs
  • func (d *Docs) Category(name string, description string, order int)
  • func (d *Docs) Function(name string, description string, ret string, args ...string)
  • func (d *Docs) Global(name string, description string)
  • func (d *Docs) PopCategory()
  • func (d *Docs) PushCategory(name string)
• type Function
• type Global

Types

type Category

type Category struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Order       int    `json:"order"`
}

type Docs

type Docs struct {
	Categories map[string]Category `json:"categories"`
	Globals    map[string]Global   `json:"globals"`
	Functions  map[string]Function `json:"functions"`
	// contains filtered or unexported fields
}

func New

func New() *Docs

func (*Docs) Category

func (d *Docs) Category(name string, description string, order int)

func (*Docs) Function

func (d *Docs) Function(name string, description string, ret string, args ...string)

func (*Docs) Global

func (d *Docs) Global(name string, description string)

func (*Docs) PopCategory

func (d *Docs) PopCategory()

func (*Docs) PushCategory

func (d *Docs) PushCategory(name string)

type Function

type Function struct {
	Name        string   `json:"name"`
	Args        []string `json:"args"`
	Return      string   `json:"return"`
	Category    string   `json:"category"`
	Description string   `json:"description"`
}

type Global

type Global struct {
	Name        string `json:"name"`
	Category    string `json:"category"`
	Description string `json:"description"`
}