doc

package

v0.0.1 Latest Latest Go to latest Published: Sep 28, 2017 License: MIT Imports: 4 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

This section is empty.

This section is empty.

This section is empty.

type Doc struct {
	Usage      string
	Parameters []Parameter
	Outputs    []Output
}

Doc represents the CF template Documentation

func Create(cfTemplate []byte) *Doc

Create creates a Doc type with the contents of the Template

type Output struct {
	Name        string
	Description string
	Export      string
}

Output represents the CF Outputs block

type Parameter struct {
	Name          string
	Description   string
	Default       string
	Type          string
	AllowedValues string
}

Parameter represents CF Parameter block