doctable

package

v0.1.2-0...-b48ce14 Latest Latest Go to latest Published: Oct 13, 2017 License: EPL-1.0 Imports: 12 Imported by: 0

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 RunDocFinder(c *cli.CliConf)

type DocFinder struct {
	*cli.CliConf
	*process.Env
}

func (d *DocFinder) ProcessFields(st *FieldAndDoc, x *ast.StructType)

func (d *DocFinder) Run() error

type FieldAndDoc struct {
	Name     string
	FieldDoc map[string]string
}

FieldAndDoc structure is intended to name a structure and then list out field names and doc comments for those fields.

func NewFieldAndDoc(name string) *FieldAndDoc

NewFieldAndDoc creates a new FieldAndDoc instance with the given name.

func (f *FieldAndDoc) Add(field string, doc ...string)

Add fills in the FieldDoc member with key value pairs where the key is the name of the field and the value is the associated documentation string.