reference

Documentation

Index

• func GenerateObjectsReferenceMarkdown(ctx context.Context) (map[string][]byte, error)
• type TypeReferenceDoc

Functions

func GenerateObjectsReferenceMarkdown

func GenerateObjectsReferenceMarkdown(ctx context.Context) (map[string][]byte, error)

* This function generates a series of markdown pages to document FireFly types, and are * designed to be included in the docs. Each page is a []byte value in the map, and the * key is the file name of the page. To add additional pages, simply create an example * instance of the type you would like to document, then include that in the `types` * array which is passed to generateMarkdownPages(). Note: It is the responsibility of * some other caller function to actually write the bytes to disk.

Types

type TypeReferenceDoc

type TypeReferenceDoc struct {
	Example           []byte
	Description       []byte
	FieldDescriptions []byte
	SubFieldTables    []byte
}