transformer

Documentation

Index

• type Transformer
  • func NewTransformer(p *parser.DoccParser, resolver *parser.ReferenceResolver, ...) *Transformer
  • func (t *Transformer) Transform(moduleName string, groupByPrefix bool, includeArticles bool) (*sdk.Output, error)

Types

type Transformer

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

Transformer converts DocC symbols to SDK schema

func NewTransformer

func NewTransformer(
	p *parser.DoccParser,
	resolver *parser.ReferenceResolver,
	tokenBuilder *parser.TokenBuilder,
	accessFilter *filter.AccessFilter,
	logger *zap.Logger,
	groupConfig *config.GroupConfig,
) *Transformer

NewTransformer creates a new transformer

func (*Transformer) Transform

func (t *Transformer) Transform(moduleName string, groupByPrefix bool, includeArticles bool) (*sdk.Output, error)

Transform converts all parsed DocC symbols to SDK output