doctable

Documentation

Index

• func RunDocFinder(c *cli.CliConf)
• type DocFinder
  • func (d *DocFinder) ProcessFields(st *FieldAndDoc, x *ast.StructType)
  • func (d *DocFinder) Run() error
• type FieldAndDoc
  • func NewFieldAndDoc(name string) *FieldAndDoc
  • func (f *FieldAndDoc) Add(field string, doc ...string)

Functions

func RunDocFinder

func RunDocFinder(c *cli.CliConf)

Types

type DocFinder

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

func (*DocFinder) ProcessFields

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

func (*DocFinder) Run

func (d *DocFinder) Run() error

type FieldAndDoc

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

func NewFieldAndDoc(name string) *FieldAndDoc

NewFieldAndDoc creates a new FieldAndDoc instance with the given name.

func (*FieldAndDoc) Add

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.