gen

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 4, 2022 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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
}

Jump to

Keyboard shortcuts

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