doc

Documentation

Index

• type Doc
  • func Create(files map[string]*ast.File) *Doc
• type Input
  • func (i *Input) Value() string
• type Output
• type Value

Types

type Doc

type Doc struct {
	Comment string
	Inputs  []Input
	Outputs []Output
}

Doc represents a terraform module doc.

func Create

func Create(files map[string]*ast.File) *Doc

Create creates a new *Doc from the supplied map of filenames and *ast.File.

type Input

type Input struct {
	Name        string
	Description string
	Default     *Value
	Type        string
}

Input represents a terraform input variable.

func (*Input) Value

func (i *Input) Value() string

Value returns the default value as a string.

type Output

type Output struct {
	Name        string
	Description string
}

Output represents a terraform output.

type Value

type Value struct {
	Type    string
	Literal string
}

Value represents a terraform value.