doc

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 20, 2020 License: GPL-3.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Documentation

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

func NewDocumentation

func NewDocumentation(name string) (*Documentation, error)

func (*Documentation) Do

func (d *Documentation) Do(name string, schema providers.GetSchemaResponse) *lib.Doc

func (*Documentation) Resource

func (d *Documentation) Resource(typ, name string) (*ResourceDocumentation, error)

type ResourceDocumentation

type ResourceDocumentation struct {
	Name    string
	Type    string
	Attribs map[string]string
	Blocks  map[string]map[string]string
}

func NewResourceDocumentation

func NewResourceDocumentation(typ, name string) *ResourceDocumentation

func (*ResourceDocumentation) AddAttrib

func (r *ResourceDocumentation) AddAttrib(name, desc string)

func (*ResourceDocumentation) AddBlockAttrib

func (r *ResourceDocumentation) AddBlockAttrib(block, name, desc string)

func (*ResourceDocumentation) Decode

func (r *ResourceDocumentation) Decode(doc io.Reader) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL