parse

Documentation

Index

• type FuncType
• type Function
• type PkgInfo
  • func Package(path string, files []string) (*PkgInfo, error)

Types

type FuncType

type FuncType int

FuncType is the type of a function that mage understands.

const (
	InvalidType FuncType = iota
	VoidType
	ErrorType
)

FuncTypes

type Function

type Function struct {
	Name     string
	IsError  bool
	Synopsis string
	Comment  string
}

type PkgInfo

type PkgInfo struct {
	Funcs          []Function
	DefaultIsError bool
	DefaultName    string
}

func Package

func Package(path string, files []string) (*PkgInfo, error)

Package parses a package