docmaster

Documentation

Index

• func RenderTemplates(options *Options, data *protoc.Result) ([]*plugin_go.CodeGeneratorResponse_File, error)
• type Format
• type Options
  • func ParseOptions(req *plugin_go.CodeGeneratorRequest) (*Options, error)
• type Plugin
  • func NewPlugin() *Plugin
  • func (d *Plugin) Generate(req *plugin_go.CodeGeneratorRequest) (*plugin_go.CodeGeneratorResponse, error)

Functions

func RenderTemplates

func RenderTemplates(options *Options, data *protoc.Result) ([]*plugin_go.CodeGeneratorResponse_File, error)

RenderTemplates ...

Types

type Format

type Format int

Format to render

const (
	NoFormat Format = 0
	Markdown Format = 1
	HTML     Format = 2
)

Format values

type Options

type Options struct {
	Format       Format
	OutputFile   string
	TemplateFile string
}

Options ...

func ParseOptions

func ParseOptions(req *plugin_go.CodeGeneratorRequest) (*Options, error)

ParseOptions ... example: format=template,template=index.txt,file=docs.html

type Plugin

type Plugin struct {
}

Plugin defines a protoc plugin

func NewPlugin

func NewPlugin() *Plugin

NewPlugin ...

func (*Plugin) Generate

func (d *Plugin) Generate(req *plugin_go.CodeGeneratorRequest) (*plugin_go.CodeGeneratorResponse, error)

Generate ...