docgen

Documentation

Overview

Package docgen contain the main functions to preprocess an AST and to write the documentation to the output file

Index

• Constants
• Variables
• func Extract(kubeTypes parser.KubeTypes, format OutputType, mdConfiguration string, ...) (string, error)
• func Output(fileName string, content string) error
• type OutputType

Constants

const (
	// OutputTypeJSON represent the JSON output type
	OutputTypeJSON = OutputType("json")

	// OutputTypeMD represent the MarkDown output type
	OutputTypeMD = OutputType("md")
)

Variables

var ErrorWrongOutputFormat = fmt.Errorf("wrong output format")

ErrorWrongOutputFormat means that the used specified an output format which we don't support

Functions

func Extract

func Extract(kubeTypes parser.KubeTypes, format OutputType, mdConfiguration string, mdTemplate string) (string, error)

Extract extracts the documentation output from the list of types given the output format and the markdown configuration file path

func Output

func Output(fileName string, content string) error

Output writes the documentation to a certain file. If the filename is empty the documentation is written to stdout

Types

type OutputType

type OutputType string

OutputType is an output type