types

Documentation

Index

• func Compare(a, b Type) bool
• func TypeString(t Type) (string, bool)
• type Docs
• type Field
• type Function
• type Interface
• type Reference
• type Type
• type Value

Functions

func Compare

func Compare(a, b Type) bool

Compare compares arguments for the purposes of sorting. Types are first ordered by type, then by string comapring their names.

func TypeString

func TypeString(t Type) (string, bool)

TypeString maps an unknown type to a string indicating its type.

Types

type Docs

type Docs struct {
	Text string
}

Docs represents documentation text attached to other types.

type Field

type Field struct {
	Name string
	Docs Docs
	Type string
}

Field represents a function argument or return value. Docs and name are optional.

type Function

type Function struct {
	Name         string
	Docs         Docs
	Arguments    []Field
	ReturnValues []Field
}

Function represents a function type. Docs, arguments and return values are optional.

type Interface

type Interface struct {
	Name     string
	Docs     Docs
	Embedded []Reference
	Methods  []Function
}

Interface represents an interface type. Docs, embedded and methods are optional.

type Reference

type Reference struct {
	Package string
	Name    string
	Docs    Docs
}

Reference represents a reference to another value. Docs and package are optional.

type Type

type Type interface{}

Type is a placeholder for a pointer to any other type in this package.

type Value

type Value struct {
	Name  string
	Docs  Docs
	Const bool
	Type  string
	Value string
}

Value represents a const or var declaration. Docs and const are optional. Exactly one of type or value should be specified.