docgen

Documentation

Index

• func GetPrefixedValue(origin, expression string) string
• type Doc
  • func GetDocumentParser(source DocItem, log logr.Logger) *Doc
  • func NewDoc(item DocItem, log logr.Logger) *Doc
  • func (d *Doc) Append(line string)
  • func (d *Doc) Generate() error
• type DocIndex
• type DocItem
• type DocItems
• type SourceDir
• type SourceLister
  • func NewSourceLister(sources map[string]SourceDir, logger logr.Logger) *SourceLister
  • func (lister *SourceLister) Generate() error
  • func (sl *SourceLister) IsWhiteListed(source string) bool
  • func (sl *SourceLister) ListSources() ([]DocItem, error)

Functions

func GetPrefixedValue

func GetPrefixedValue(origin, expression string) string

Types

type Doc

type Doc struct {
	Item        DocItem
	DisplayName string
	Content     string
	Version     string
	Url         string
	Desc        string
	Status      string

	RootNode *ast.File
	Logger   logr.Logger
}

func GetDocumentParser

func GetDocumentParser(source DocItem, log logr.Logger) *Doc

func NewDoc

func NewDoc(item DocItem, log logr.Logger) *Doc

func (*Doc) Append

func (d *Doc) Append(line string)

func (*Doc) Generate

func (d *Doc) Generate() error

type DocIndex

type DocIndex struct {
	Path string
}

type DocItem

type DocItem struct {
	Name                         string
	SourcePath                   string
	DestPath                     string
	Category                     string
	DefaultValueFromTagExtractor func(string) string
}

type DocItems

type DocItems []DocItem

type SourceDir

type SourceDir struct {
	Path     string
	DestPath string
}

type SourceLister

type SourceLister struct {
	Logger                       logr.Logger
	Sources                      map[string]SourceDir
	IgnoredSources               []string
	DefaultValueFromTagExtractor func(string) string
	Index                        *Doc
	DocGeneratedHook             func(doc *Doc) error
	Header                       string
	Footer                       string
}

func NewSourceLister

func NewSourceLister(sources map[string]SourceDir, logger logr.Logger) *SourceLister

func (*SourceLister) Generate

func (lister *SourceLister) Generate() error

func (*SourceLister) IsWhiteListed

func (sl *SourceLister) IsWhiteListed(source string) bool

func (*SourceLister) ListSources

func (sl *SourceLister) ListSources() ([]DocItem, error)