xdoc

Documentation

Index

• type DocInfo
  • func New(toDoc string) *DocInfo
• type Function
  • func (sf Function) Signature() string
• type Functions
  • func (m Functions) SortedKeys() []string
• type Struct
• type Structs
  • func (m Structs) SortedKeys() []string
• type Value
  • func (sv Value) Signature() string
• type Values
  • func (m Values) SortedKeys() []string

Types

type DocInfo

type DocInfo struct {
	PackageDoc  string
	PackageName string
	Constants   Values
	Variables   Values
	Functions   Functions
	Structs     Structs
}

func New

func New(toDoc string) *DocInfo

type Function

type Function struct {
	Name string
	Doc  string
	// contains filtered or unexported fields
}

func (Function) Signature

func (sf Function) Signature() string

type Functions

type Functions map[string]*Function

func (Functions) SortedKeys

func (m Functions) SortedKeys() []string

type Struct

type Struct struct {
	Name         string
	Constructors Functions
	Methods      Functions
	Fields       []string
	Doc          string
}

type Structs

type Structs map[string]*Struct

func (Structs) SortedKeys

func (m Structs) SortedKeys() []string

type Value

type Value struct {
	Name       string
	Value      string
	IsConstant bool
	Doc        string
}

func (Value) Signature

func (sv Value) Signature() string

type Values

type Values map[string]*Value

func (Values) SortedKeys

func (m Values) SortedKeys() []string