docs

Documentation

Index

• type Group
  • func (g *Group) Child(path, fullPath string, descs []string) Group
  • func (g *Group) CreateReadme(title string, descs []string)
  • func (g *Group) LinkInReadme(title, href string, desc []string, isRoute bool)
  • func (g *Group) Route(method, path, fullPath string, handler interface{})
  • func (g *Group) SetDir(dir string)
  • func (g *Group) Valid() bool
• type Route
  • func (r *Route) Body(buf *bytes.Buffer)
  • func (r *Route) Desc(buf *bytes.Buffer)
  • func (r *Route) Doc(method, fullPath string) []byte
  • func (r *Route) Header(buf *bytes.Buffer)
  • func (r *Route) MethodPath(method, fullPath string) string
  • func (r *Route) Param(buf *bytes.Buffer, fullPath string)
  • func (r *Route) Parse(handler interface{}) bool
  • func (r *Route) Query(buf *bytes.Buffer)
  • func (r *Route) RespBody(buf *bytes.Buffer)
  • func (r *Route) RespError(buf *bytes.Buffer)
  • func (r *Route) RespHeader(buf *bytes.Buffer)
  • func (r *Route) Title() string

Types

type Group

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

Group for docs generation. Every docs.Group has an one-to-one goa.RouterGroup. A group can be inline, that means its docs is generated in its parent's REAMED file.

func (*Group) Child

func (g *Group) Child(path, fullPath string, descs []string) Group

func (*Group) CreateReadme

func (g *Group) CreateReadme(title string, descs []string)

func (*Group) LinkInReadme

func (g *Group) LinkInReadme(title, href string, desc []string, isRoute bool)

func (*Group) Route

func (g *Group) Route(method, path, fullPath string, handler interface{})

func (*Group) SetDir

func (g *Group) SetDir(dir string)

func (*Group) Valid

func (g *Group) Valid() bool

type Route

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

func (*Route) Body

func (r *Route) Body(buf *bytes.Buffer)

func (*Route) Desc

func (r *Route) Desc(buf *bytes.Buffer)

func (*Route) Doc

func (r *Route) Doc(method, fullPath string) []byte

func (*Route) Header

func (r *Route) Header(buf *bytes.Buffer)

func (*Route) MethodPath

func (r *Route) MethodPath(method, fullPath string) string

func (*Route) Param

func (r *Route) Param(buf *bytes.Buffer, fullPath string)

func (*Route) Parse

func (r *Route) Parse(handler interface{}) bool

func (*Route) Query

func (r *Route) Query(buf *bytes.Buffer)

func (*Route) RespBody

func (r *Route) RespBody(buf *bytes.Buffer)

func (*Route) RespError

func (r *Route) RespError(buf *bytes.Buffer)

func (*Route) RespHeader

func (r *Route) RespHeader(buf *bytes.Buffer)

func (*Route) Title

func (r *Route) Title() string