yakdoc

Documentation

Index

• Variables
• func ASTGetTypeName(expr ast.Expr, fset *token.FileSet) string
• func CustomHandleTypeName(typName string) string
• func GetDeclAndCompletion(funcName string, params, results []*Field) (string, string)
• func GetProjectAstPackages() (map[string]*ast.Package, *token.FileSet, error)
• func GetProjectPath() string
• func GetTypeNameWithPkgPath(typ reflect.Type) (pkgPath string, pkgPathName string)
• func RegisterHook(hook func(h *DocumentHelper))
• func ShrinkTypeVerboseName(i string) string
• type CacheAstBundle
  • func GetCacheAstBundle(fileName string) (*CacheAstBundle, error)
• type DeprecateFunction
• type DocumentHelper
  • func (h *DocumentHelper) Callback()
  • func (h *DocumentHelper) GetAllLibs() []string
  • func (h *DocumentHelper) HelpInfo() string
  • func (h *DocumentHelper) InjectInterfaceDocumentManually(interfacePath, sourceCodePath string) error
  • 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 Field
  • func HandleFieldsRaw(fieldStr string) []*Field
  • func HandleParams(funcRefType reflect.Type, typ *ast.FuncType, fset *token.FileSet) (params []*Field)
  • func HandleResults(funcRefType reflect.Type, typ *ast.FuncType, fset *token.FileSet) (results []*Field)
• type FuncDecl
  • func FuncToFuncDecl(f interface{}, libName string, overideName string) (*FuncDecl, error)
  • 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*\{\}`)

	ErrAutoGenerated    = utils.Error("file is <autogenerated>")
	ErrIsInstanceMethod = utils.Error("function is instance method")
)

Functions

func ASTGetTypeName

func ASTGetTypeName(expr ast.Expr, fset *token.FileSet) string

func CustomHandleTypeName

func CustomHandleTypeName(typName string) string

func GetDeclAndCompletion

func GetDeclAndCompletion(funcName string, params, results []*Field) (string, string)

func GetProjectAstPackages

func GetProjectAstPackages() (map[string]*ast.Package, *token.FileSet, error)

func GetProjectPath

func GetProjectPath() string

func GetTypeNameWithPkgPath

func GetTypeNameWithPkgPath(typ reflect.Type) (pkgPath string, pkgPathName string)

func RegisterHook

func RegisterHook(hook func(h *DocumentHelper))

func ShrinkTypeVerboseName

func ShrinkTypeVerboseName(i string) string

rename native type

Types

type CacheAstBundle

type CacheAstBundle struct {
	// contains filtered or unexported fields
}

func GetCacheAstBundle

func GetCacheAstBundle(fileName string) (*CacheAstBundle, error)

type DeprecateFunction

type DeprecateFunction struct {
	Name string
	Self *FuncDecl
	Msg  string
}

type DocumentHelper

type DocumentHelper struct {
	Libs                map[string]*ScriptLib
	Functions           map[string]*FuncDecl
	Instances           map[string]*LibInstance
	StructMethods       map[string]*ScriptLib // 结构体方法，名字 -> 所有结构体与结构体指针方法
	DeprecatedFunctions []*DeprecateFunction
	// contains filtered or unexported fields
}

func (*DocumentHelper) Callback

func (h *DocumentHelper) Callback()

func (*DocumentHelper) GetAllLibs

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

func (*DocumentHelper) HelpInfo

func (h *DocumentHelper) HelpInfo() string

func (*DocumentHelper) InjectInterfaceDocumentManually

func (h *DocumentHelper) InjectInterfaceDocumentManually(interfacePath, sourceCodePath string) error

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 Field

type Field struct {
	Name    string
	Type    string
	RefType reflect.Type
}

func HandleFieldsRaw

func HandleFieldsRaw(fieldStr string) []*Field

func HandleParams

func HandleParams(funcRefType reflect.Type, typ *ast.FuncType, fset *token.FileSet) (params []*Field)

func HandleResults

func HandleResults(funcRefType reflect.Type, typ *ast.FuncType, fset *token.FileSet) (results []*Field)

type FuncDecl

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

	Params  []*Field
	Results []*Field

	VSCodeSnippets string
}

func FuncToFuncDecl

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

Get description and declaration of a func

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
	Instances   map[string]*LibInstance
	Functions   map[string]*FuncDecl
	ElementDocs []string
}

func (*ScriptLib) String

func (l *ScriptLib) String() string