doccompiler

Documentation

Index

• Constants
• Variables
• func CreateDocEntry(dataRoot string, subFolders ...string) (common.DocEntry, error)
• func FileExists(filename string) (bool, error)
• func GetMarkDownFile(dataRoot string, subFolders []string, file string) (string, error)
• func ReadAndUnmarshal(filename string, output interface{}) error
• func SortedParamsKeys(paramsMap map[string][]string) []string
• type DocCompiler
  • func New() DocCompiler

Constants

const (
	ExitCodeOk int = iota
	ExitCodeFailedReadParams
	ExitCodeFailedHandleAction
	ExitCodeFailedConfigFields
	ExitCodeFailedHandleConfig
	ExitCodeFailedWriteResult
	ExitCodeFailedReadGroups
	ExitCodeFailedHandleGroups
	ExitCodeFailedReadTemplate
	ExitCodeFailedParseTemplate
	ExitCodeFailedExecuteTemplate
	ExitCodeFailedCreateExtra
	ExitCodeFailedSyntaxError
	ExitCodeFailedNoDataRoot
	ExitCodeFailedListDir
)

ExitCodes

const TemplateStr = `` /* 1960-byte string literal not displayed */

TemplateStr used to generate in memory documentation golang package

Variables

var FuncMap = template.FuncMap{
	"params": SortedParamsKeys,
	"join":   strings.Join,
}

var UseFolderStructure = false

Functions

func CreateDocEntry

func CreateDocEntry(dataRoot string, subFolders ...string) (common.DocEntry, error)

CreateDocEntry create DocEntry using files in sub folder

func FileExists

func FileExists(filename string) (bool, error)

FileExists check if file exists

func GetMarkDownFile

func GetMarkDownFile(dataRoot string, subFolders []string, file string) (string, error)

GetMarkDownFile read markdown file into memory and do necessary escaping

func ReadAndUnmarshal

func ReadAndUnmarshal(filename string, output interface{}) error

ReadAndUnmarshal file to object

func SortedParamsKeys

func SortedParamsKeys(paramsMap map[string][]string) []string

SortedParamsKeys returns map keys as a sorted slice

Types

type DocCompiler

type DocCompiler interface {
	// Compile documentation to golang represented as bytes
	Compile() []byte
	// CompileToFile compiles the data to file
	CompileToFile(file string)
	// Add documentation data from directory
	AddDataFromDir(dir string)
	// Add documentation data from variables in generated code
	AddDataFromGenerated(actions, config, extra map[string]common.DocEntry, params map[string][]string, groups []common.GroupsEntry)
}

func New

func New() DocCompiler