docs_generator

Documentation

Index

• type CompatibleComponentsListGenerator
  • func NewConsumersListGenerator(t metadata.Type, filePath string) *CompatibleComponentsListGenerator
  • func NewExportersListGenerator(t metadata.Type, filePath string) *CompatibleComponentsListGenerator
  • func (c *CompatibleComponentsListGenerator) Generate() (string, error)
  • func (c *CompatibleComponentsListGenerator) Name() string
  • func (c *CompatibleComponentsListGenerator) Read() (string, error)
  • func (c *CompatibleComponentsListGenerator) Write() error
• type DocsGenerator
• type LinksToTypesGenerator
  • func NewLinksToTypesGenerator(component string) *LinksToTypesGenerator
  • func (l *LinksToTypesGenerator) Generate() (string, error)
  • func (l *LinksToTypesGenerator) Name() string
  • func (l *LinksToTypesGenerator) Read() (string, error)
  • func (l *LinksToTypesGenerator) Write() error

Types

type CompatibleComponentsListGenerator

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

func NewConsumersListGenerator

func NewConsumersListGenerator(t metadata.Type, filePath string) *CompatibleComponentsListGenerator

func NewExportersListGenerator

func NewExportersListGenerator(t metadata.Type, filePath string) *CompatibleComponentsListGenerator

func (*CompatibleComponentsListGenerator) Generate

func (c *CompatibleComponentsListGenerator) Generate() (string, error)

func (*CompatibleComponentsListGenerator) Name

func (c *CompatibleComponentsListGenerator) Name() string

func (*CompatibleComponentsListGenerator) Read

func (c *CompatibleComponentsListGenerator) Read() (string, error)

func (*CompatibleComponentsListGenerator) Write

func (c *CompatibleComponentsListGenerator) Write() error

type DocsGenerator

type DocsGenerator interface {
	Name() string
	Generate() (string, error)
	Read() (string, error)
	Write() error
}

type LinksToTypesGenerator

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

func NewLinksToTypesGenerator

func NewLinksToTypesGenerator(component string) *LinksToTypesGenerator

func (*LinksToTypesGenerator) Generate

func (l *LinksToTypesGenerator) Generate() (string, error)

func (*LinksToTypesGenerator) Name

func (l *LinksToTypesGenerator) Name() string

func (*LinksToTypesGenerator) Read

func (l *LinksToTypesGenerator) Read() (string, error)

func (*LinksToTypesGenerator) Write

func (l *LinksToTypesGenerator) Write() error