docgen

Documentation

Index

• Constants
• Variables
• func ExampleValue(method string, t, parent reflect.Type) interface{}
• func Generate(out io.Writer, iface, pkg string, ainfo ApiASTInfo) error
• func GetAPIType(name, pkg string) (i interface{}, t reflect.Type, permStruct []reflect.Type)
• func MethodGroupFromName(mn string) string
• type ApiASTInfo
  • func ParseApiASTInfo(apiFile, iface, pkg, dir string) (ApiASTInfo, error)
• type Method
• type MethodGroup
• type Visitor
  • func (v *Visitor) Visit(node ast.Node) ast.Visitor

Constants

const NoComment = "There are not yet any comments for this method."

Variables

var ExampleValues = map[reflect.Type]interface{}{
	reflect.TypeOf(api.MinerSubsystem(0)): api.MinerSubsystem(1),
	reflect.TypeOf(auth.Permission("")):   auth.Permission("write"),
	reflect.TypeOf(""):                    "string value",
	reflect.TypeOf(uint64(42)):            uint64(42),
	reflect.TypeOf(byte(7)):               byte(7),
	reflect.TypeOf([]byte{}):              []byte("byte array"),
}

Functions

func ExampleValue

func ExampleValue(method string, t, parent reflect.Type) interface{}

func Generate

func Generate(out io.Writer, iface, pkg string, ainfo ApiASTInfo) error

func GetAPIType

func GetAPIType(name, pkg string) (i interface{}, t reflect.Type, permStruct []reflect.Type)

func MethodGroupFromName

func MethodGroupFromName(mn string) string

Types

type ApiASTInfo

type ApiASTInfo struct {
	Comments      map[string]string
	GroupComments map[string]string
}

func ParseApiASTInfo

func ParseApiASTInfo(apiFile, iface, pkg, dir string) (ApiASTInfo, error)

type Method

type Method struct {
	Comment         string
	Name            string
	InputExample    string
	ResponseExample string
}

type MethodGroup

type MethodGroup struct {
	GroupName string
	Header    string
	Methods   []*Method
}

type Visitor

type Visitor struct {
	Root    string
	Methods map[string]ast.Node
}

func (*Visitor) Visit

func (v *Visitor) Visit(node ast.Node) ast.Visitor