genmd

Documentation

Index

• Constants
• func GenerateMarkdown(docs *CompiledDocs)
• func MarkdownParams(obj interface{}, paramDocs map[string][]string) string
• func UngroupedActions(groups []common.GroupsEntry) []string
• type CompiledDocs
• type DocEntry
  • func (doc DocEntry) String() string
• type DocEntryWithParams
  • func (doc DocEntryWithParams) String() string
• type DocNode
  • func NewDocNode(doc fmt.Stringer) DocNode
  • func NewFoldedDocNode(foldStr string, doc fmt.Stringer) DocNode
• type DocNodeStruct
  • func (node *DocNodeStruct) AddChild(child DocNode)
  • func (node *DocNodeStruct) Children() []DocNode
  • func (node *DocNodeStruct) WriteTo(writer io.Writer)
• type EmptyDocEntry
  • func (doc EmptyDocEntry) String() string
• type FoldedDocNode
  • func (node *FoldedDocNode) WriteTo(writer io.Writer)

Constants

const (
	ExitCodeOk = iota
	ExitCodeFailedReadTemplate
	ExitCodeFailedParseTemplate
	ExitCodeFailedExecuteTemplate
	ExitCodeFailedWriteResult
	ExitCodeFailedHandleFields
	ExitCodeFailedHandleParams
)

Functions

func GenerateMarkdown

func GenerateMarkdown(docs *CompiledDocs)

func MarkdownParams

func MarkdownParams(obj interface{}, paramDocs map[string][]string) string

func UngroupedActions

func UngroupedActions(groups []common.GroupsEntry) []string

UngroupedActions filter grouped actions from all actions

Types

type CompiledDocs

type CompiledDocs struct {
	Actions map[string]common.DocEntry
	Params  map[string][]string
	Config  map[string]common.DocEntry
	Groups  []common.GroupsEntry
	Extra   map[string]common.DocEntry
}

type DocEntry

type DocEntry common.DocEntry

func (DocEntry) String

func (doc DocEntry) String() string

type DocEntryWithParams

type DocEntryWithParams struct {
	DocEntry
	Params string
}

func (DocEntryWithParams) String

func (doc DocEntryWithParams) String() string

type DocNode

type DocNode interface {
	WriteTo(io.Writer)
	AddChild(DocNode)
	Children() []DocNode
}

func NewDocNode

func NewDocNode(doc fmt.Stringer) DocNode

func NewFoldedDocNode

func NewFoldedDocNode(foldStr string, doc fmt.Stringer) DocNode

type DocNodeStruct

type DocNodeStruct struct {
	// contains filtered or unexported fields
}

func (*DocNodeStruct) AddChild

func (node *DocNodeStruct) AddChild(child DocNode)

func (*DocNodeStruct) Children

func (node *DocNodeStruct) Children() []DocNode

func (*DocNodeStruct) WriteTo

func (node *DocNodeStruct) WriteTo(writer io.Writer)

type EmptyDocEntry

type EmptyDocEntry struct{}

func (EmptyDocEntry) String

func (doc EmptyDocEntry) String() string

type FoldedDocNode

type FoldedDocNode struct {
	Name string
	DocNode
}

func (*FoldedDocNode) WriteTo

func (node *FoldedDocNode) WriteTo(writer io.Writer)