gen

Documentation

Index

• func GenerateBuiltins(ctx context.Context, r io.Reader) ([]byte, error)
• type Builtin
• type BuiltinData
• type Documentation
  • func GenerateDocumentation(ctx context.Context, r io.Reader) (*Documentation, error)
• type Field
• type Func
• type ParsedFunc

Functions

func GenerateBuiltins

func GenerateBuiltins(ctx context.Context, r io.Reader) ([]byte, error)

Types

type Builtin

type Builtin struct {
	Type  string
	Funcs []*Func
}

type BuiltinData

type BuiltinData struct {
	Command     string
	FuncsByKind map[ast.Kind][]ParsedFunc
	Reference   string
}

type Documentation

type Documentation struct {
	Builtins []Builtin
}

Documentation contains all the builtin functions defined for HLB.

func GenerateDocumentation

func GenerateDocumentation(ctx context.Context, r io.Reader) (*Documentation, error)

type Field

type Field struct {
	Doc      string
	Variadic bool
	Type     string
	Name     string
}

type Func

type Func struct {
	Doc     string
	Type    string
	Name    string
	Params  []Field
	Options []*Func
}

type ParsedFunc

type ParsedFunc struct {
	Name    string
	Params  []*ast.Field
	Effects []*ast.Field
}