yakdoc

Documentation

Index

• Variables
• type DocumentHelper
  • func (h *DocumentHelper) GetAllLibs() []string
  • func (h *DocumentHelper) HelpInfo() string
  • func (h *DocumentHelper) LibFuncAutoCompletion(libName, funcName string) string
  • func (h *DocumentHelper) LibFuncDefinitionStr(libName, funcName string) string
  • func (h *DocumentHelper) LibFuncHelpInfo(libName, funcName string) string
  • func (h *DocumentHelper) LibHelpInfo(name string) string
  • func (h *DocumentHelper) ShowHelpInfo()
  • func (h *DocumentHelper) ShowLibFuncHelpInfo(libName, funcName string)
  • func (h *DocumentHelper) ShowLibHelpInfo(name string)
• type FuncDecl
  • func FuncToFuncDecl(libName, methodName string, f interface{}) *FuncDecl
  • func (f *FuncDecl) String() string
• type LibInstance
  • func AnyTypeToLibInstance(libName, name string, typ reflect.Type, value interface{}) *LibInstance
  • func (i *LibInstance) String() string
• type ScriptLib
  • func (l *ScriptLib) String() string

Variables

var (
	InterfaceToAnyRegep, _ = regexp.Compile(`interface\s*\{\}`)
)

Types

type DocumentHelper

type DocumentHelper struct {
	Libs      map[string]*ScriptLib
	Functions map[string]*FuncDecl
	Instances map[string]*LibInstance
}

func (*DocumentHelper) GetAllLibs

func (h *DocumentHelper) GetAllLibs() []string

func (*DocumentHelper) HelpInfo

func (h *DocumentHelper) HelpInfo() string

func (*DocumentHelper) LibFuncAutoCompletion

func (h *DocumentHelper) LibFuncAutoCompletion(libName, funcName string) string

func (*DocumentHelper) LibFuncDefinitionStr

func (h *DocumentHelper) LibFuncDefinitionStr(libName, funcName string) string

func (*DocumentHelper) LibFuncHelpInfo

func (h *DocumentHelper) LibFuncHelpInfo(libName, funcName string) string

func (*DocumentHelper) LibHelpInfo

func (h *DocumentHelper) LibHelpInfo(name string) string

func (*DocumentHelper) ShowHelpInfo

func (h *DocumentHelper) ShowHelpInfo()

func (*DocumentHelper) ShowLibFuncHelpInfo

func (h *DocumentHelper) ShowLibFuncHelpInfo(libName, funcName string)

func (*DocumentHelper) ShowLibHelpInfo

func (h *DocumentHelper) ShowLibHelpInfo(name string)

type FuncDecl

type FuncDecl struct {
	LibName        string
	MethodName     string
	Document       string
	Decl           string
	VSCodeSnippets string
}

func FuncToFuncDecl

func FuncToFuncDecl(libName, methodName string, f interface{}) *FuncDecl

func (*FuncDecl) String

func (f *FuncDecl) String() string

type LibInstance

type LibInstance struct {
	LibName      string
	InstanceName string
	Type         string
	ValueStr     string
}

func AnyTypeToLibInstance

func AnyTypeToLibInstance(libName, name string, typ reflect.Type, value interface{}) *LibInstance

func (*LibInstance) String

func (i *LibInstance) String() string

type ScriptLib

type ScriptLib struct {
	Name          string
	LibsInstances []*LibInstance
	Functions     map[string]*FuncDecl
	ElementDocs   []string
}

func (*ScriptLib) String

func (l *ScriptLib) String() string