types

package
Version: v0.5.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 13, 2019 License: MIT Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config struct {
	Name    string
	Version string
	Prefix  string
	Help    Help
}

Config provides Kombustion with information about your plugin

type Help

type Help struct {
	// A short description of what the plugin does
	Description string

	// Examples/Snippets of how this plugin can be used
	Snippets []string
	Types    []TypeMapping
}

Help - a set of available documentation fields

type PluginParserResult added in v0.3.0

PluginParserResult result of a parserFunc

type TypeMapping

type TypeMapping struct {
	Name        string
	Description string
	Config      interface{}
}

TypeMapping - recursive list of types with its associated config object

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL