doc

Documentation

Index

• Constants
• func Doc() error
• type ResourceDoc
  • func Parse(cfn string) (docs []*ResourceDoc)
  • func ReadCfn(paths ...string) (docs []*ResourceDoc, err error)

Constants

const (
	StartTag = `<cfndoc>`
	EndTag   = `</cfndoc>`
)

TODO - Parse CfnDoc as yaml field instead of comment, then group by resource type

Functions

func Doc

func Doc() error

Preview auto-generated documentation in out/doc

Types

type ResourceDoc

type ResourceDoc struct {
	FieldName     string // "QueueName", "FunctionName", etc
	Resource      string // referenced label
	Documentation string
}

func Parse

func Parse(cfn string) (docs []*ResourceDoc)

func ReadCfn

func ReadCfn(paths ...string) (docs []*ResourceDoc, err error)