gendoc

package module

Go to main page

Versions in this module

v1

v1.5.5

Apr 19, 2024

v1.5.4

Jun 12, 2023

v1.5.3

Jun 12, 2023

Changes in this version

+ type LinkedMessageField struct

+ Children []*LinkedMessageField

+ Self *MessageField

+ func GetContent(files []*File, baseMessage string) []*LinkedMessageField

v1.5.2

Mar 17, 2022

Changes in this version

+ var SupportedFeatures = uint64(plugin_go.CodeGeneratorResponse_FEATURE_PROTO3_OPTIONAL)

+ func AnchorFilter(str string) string

type Message

+ HasOneofs bool

type MessageField

+ IsOneof bool

+ OneofDecl string

type PluginOptions

+ SourceRelative bool

v1.3.0

Apr 15, 2019

Changes in this version

type Enum

+ Options map[string]interface{}

+ func (e Enum) Option(name string) interface{}

+ func (e Enum) ValueOptions() []string

+ func (e Enum) ValuesWithOption(optionName string) []*EnumValue

type EnumValue

+ Options map[string]interface{}

+ func (v EnumValue) Option(name string) interface{}

type File

+ Options map[string]interface{}

+ func (f File) Option(name string) interface{}

type Message

+ Options map[string]interface{}

+ func (m Message) FieldOptions() []string

+ func (m Message) FieldsWithOption(optionName string) []*MessageField

+ func (m Message) Option(name string) interface{}

type MessageField

+ Options map[string]interface{}

+ func (f MessageField) Option(name string) interface{}

type Service

+ Options map[string]interface{}

+ func (s Service) MethodOptions() []string

+ func (s Service) MethodsWithOption(optionName string) []*ServiceMethod

+ func (s Service) Option(name string) interface{}

type ServiceMethod

+ Options map[string]interface{}

+ func (m ServiceMethod) Option(name string) interface{}

v1.2.0

Mar 13, 2019

Changes in this version

type MessageField

+ IsMap bool

type ServiceMethod

+ RequestStreaming bool

+ ResponseStreaming bool

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

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL