docgen

Documentation

Index

• type DocsGenerator
  • func NewDocsGenerator(lc library.Client) DocsGenerator
• type Kind
• type Snapshot
  • func NewSnapshot() *Snapshot
  • func (s *Snapshot) WalkDelta(fn func(doc *library.DocView))

Types

type DocsGenerator

type DocsGenerator interface {
	GenerateForPackage(ctx context.Context, libId string, verId string, pkgId string) error
}

func NewDocsGenerator

func NewDocsGenerator(lc library.Client) DocsGenerator

type Kind

type Kind string

const (
	KindInput     Kind = "input"
	KindOutput    Kind = "output"
	KindCache     Kind = "cache"
	KindBuffer    Kind = "buffer"
	KindProcessor Kind = "processor"
	KindRateLimit Kind = "rate_limit"
	KindTracer    Kind = "tracer"
	KindScanner   Kind = "scanner"
	KindMetric    Kind = "metric"

	KindFunction Kind = "function"
	KindMethod   Kind = "method"
)

type Snapshot

type Snapshot struct {
	Inputs     map[string]struct{}
	Outputs    map[string]struct{}
	Caches     map[string]struct{}
	Buffers    map[string]struct{}
	Processors map[string]struct{}
	RateLimits map[string]struct{}
	Tracers    map[string]struct{}
	Scanners   map[string]struct{}
	Metrics    map[string]struct{}

	Functions map[string]struct{}
	Methods   map[string]struct{}
}

func NewSnapshot

func NewSnapshot() *Snapshot

func (*Snapshot) WalkDelta

func (s *Snapshot) WalkDelta(fn func(doc *library.DocView))