Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  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

gendoc

package module

Go to main page

Versions in this module

v1

v1.1.0

Mar 13, 2018

Changes in this version

+ type Plugin struct

+ func (p *Plugin) Generate(r *plugin_go.CodeGeneratorRequest) (*plugin_go.CodeGeneratorResponse, error)

type PluginOptions

+ ExcludePatterns []*regexp.Regexp

v1.0.0

Sep 26, 2017

Changes in this version

+ const VERSION

+ func NoBrFilter(content string) string

+ func PFilter(content string) template.HTML

+ func ParaFilter(content string) string

+ func RenderTemplate(kind RenderType, template *Template, inputTemplate string) ([]byte, error)

+ func RunPlugin(request *plugin_go.CodeGeneratorRequest) (*plugin_go.CodeGeneratorResponse, error)

+ type Enum struct

+ Description string

+ FullName string

+ LongName string

+ Name string

+ Values []*EnumValue

+ type EnumValue struct

+ Description string

+ Name string

+ Number string

+ type File struct

+ Description string

+ Enums orderedEnums

+ Extensions orderedExtensions

+ HasEnums bool

+ HasExtensions bool

+ HasMessages bool

+ HasServices bool

+ Messages orderedMessages

+ Name string

+ Package string

+ Services orderedServices

+ type FileExtension struct

+ ContainingFullType string

+ ContainingLongType string

+ ContainingType string

+ DefaultValue string

+ Description string

+ FullName string

+ FullType string

+ Label string

+ LongName string

+ LongType string

+ Name string

+ Number int

+ Type string

+ type Message struct

+ Description string

+ Extensions []*MessageExtension

+ Fields []*MessageField

+ FullName string

+ HasExtensions bool

+ HasFields bool

+ LongName string

+ Name string

+ type MessageExtension struct

+ ScopeFullType string

+ ScopeLongType string

+ ScopeType string

+ type MessageField struct

+ DefaultValue string

+ Description string

+ FullType string

+ Label string

+ LongType string

+ Name string

+ Type string

+ type PluginOptions struct

+ OutputFile string

+ TemplateFile string

+ Type RenderType

+ func ParseOptions(req *plugin_go.CodeGeneratorRequest) (*PluginOptions, error)

+ type Processor interface

+ Apply func(template *Template) ([]byte, error)

+ type RenderType int8

+ const RenderTypeDocBook

+ const RenderTypeHTML

+ const RenderTypeJSON

+ const RenderTypeMarkdown

+ func NewRenderType(renderType string) (RenderType, error)

+ type ScalarValue struct

+ CSharp string

+ CppType string

+ GoType string

+ JavaType string

+ Notes string

+ PhpType string

+ ProtoType string

+ PythonType string

+ RubyType string

+ type Service struct

+ Description string

+ FullName string

+ LongName string

+ Methods []*ServiceMethod

+ Name string

+ type ServiceMethod struct

+ Description string

+ Name string

+ RequestFullType string

+ RequestLongType string

+ RequestType string

+ ResponseFullType string

+ ResponseLongType string

+ ResponseType string

+ type Template struct

+ Files []*File

+ Scalars []*ScalarValue

+ func NewTemplate(pr *parser.ParseResult) *Template

v1.0.0-rc

Aug 9, 2017

v1.0.0-beta

Aug 1, 2017

v1.0.0-alpha

Jul 27, 2017