doc

package

v0.0.0-...-a2101d5 Latest Latest Go to latest Published: Jul 16, 2016 License: MIT Imports: 8 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func Doc(input []string, output string)

func ReadRsc(file string) string

type FunctionData struct {
	Name        string
	Sig         string
	Description string
	Example     interface{}
	Source      interface{}
}

type FunctionDoc struct {
	// contains filtered or unexported fields
}

func (f *FunctionDoc) Data() FunctionData

func (f *FunctionDoc) HasMeta(name string) bool

func (f *FunctionDoc) Meta(name string) string

func (f *FunctionDoc) String() string

type GroupData struct {
	Group     string
	GroupID   string
	Functions *[]FunctionData
}

func NewGroupData(name string) GroupData

func (g GroupData) AddFunctionData(fd FunctionData)

func (g GroupData) Len() int

Allow sorting functions by name

func (g GroupData) Less(i, j int) bool

func (g GroupData) Swap(i, j int)

type GroupDatas []GroupData

Allow sorting GroupDatas by name

func (g *GroupDatas) Add(val GroupData)

func (g GroupDatas) Len() int

func (g GroupDatas) Less(i, j int) bool

func (g GroupDatas) Swap(i, j int)