docs_generator

package

v1.1.1 Latest Latest Go to latest Published: May 30, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Rendered for

This section is empty.

This section is empty.

This section is empty.

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

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 interface {
	Name() string
	Generate() (string, error)
	Read() (string, error)
	Write() error
}

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

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