cfndoc

Documentation

Index

• Constants
• type ByLabel
  • func (a ByLabel) Len() int
  • func (a ByLabel) Less(i, j int) bool
  • func (a ByLabel) Swap(i, j int)
• type ResourceDoc
  • func Parse(cfn string) (docs []*ResourceDoc)
  • func Read(fileName string) (docs []*ResourceDoc, err error)
  • func ReadCfn(paths ...string) (docs []*ResourceDoc, err error)

Constants

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

Types

type ByLabel

type ByLabel []*ResourceDoc

func (ByLabel) Len

func (a ByLabel) Len() int

func (ByLabel) Less

func (a ByLabel) Less(i, j int) bool

func (ByLabel) Swap

func (a ByLabel) Swap(i, j int)

type ResourceDoc

type ResourceDoc struct {
	Resource      string // referenced label
	Documentation string
}

func Parse

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

func Read

func Read(fileName string) (docs []*ResourceDoc, err error)

func ReadCfn

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