Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

doc

package

Go to main page

Versions in this module

v0

v0.6.0

Dec 13, 2018

Changes in this version

type Input

+ func (i *Input) IsAggregateType() bool

type Value

+ func (v Value) IsAggregateType() bool

v0.5.0

Oct 24, 2018

Changes in this version

+ func SortInputsByRequired(inputs []Input)

v0.4.5

Oct 7, 2018

v0.4.0

Sep 23, 2018

Changes in this version

+ func SortInputsByName(inputs []Input)

+ func SortOutputsByName(outputs []Output)

+ type Doc struct

+ Comment string

+ Inputs []Input

+ Outputs []Output

+ func Create(files map[string]*ast.File) *Doc

+ func CreateFromPaths(paths []string) (*Doc, error)

+ func TestDoc(t testing.T, path string) *Doc

+ func TestDocFromFile(t testing.T, path string, name string) *Doc

+ func (d *Doc) HasComment() bool

+ func (d *Doc) HasInputs() bool

+ func (d *Doc) HasOutputs() bool

+ type Input struct

+ Default *Value

+ Description string

+ Name string

+ Type string

+ func (i *Input) GetDefault() *Value

+ func (i *Input) HasDefault() bool

+ func (i *Input) HasDescription() bool

+ func (i *Input) IsOptional() bool

+ func (i *Input) IsRequired() bool

+ type Output struct

+ Description string

+ Name string

+ func (o *Output) HasDescription() bool

+ type Value struct

+ Type string

+ Value interface{}