common

package
v0.6.21 Latest Latest
Warning

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

Go to latest
Published: Jan 12, 2021 License: MIT Imports: 8 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// IgnoreActions list of "helper" actions to be ignored for documentation
	IgnoreActions = []string{"connectws"}
)

Shared global variables for compile and generate documentation

Functions

func ActionStrings

func ActionStrings() []string

ActionStrings all registered actions

func Actions

func Actions() map[string]interface{}

Actions all registered actions with action settings

func Exit

func Exit(err error, code int)

Exit prints errors message and exits program with code

func Fields

func Fields() (map[string]interface{}, error)

Fields config fields sections with objects

func FieldsString

func FieldsString() ([]string, error)

FieldsString config fields sections

func Keys

func Keys(m map[string]DocEntry) []string

Keys returns a sorted slice of map keys

func ReadFile

func ReadFile(path string) ([]byte, error)

ReadFile into memory

Types

type DocEntry

type DocEntry struct {
	// Description Information preceding parameters
	Description string
	// Examples Information subsequent to parameters
	Examples string
}

DocEntry contains strings and examples

type GroupsEntry

type GroupsEntry struct {
	// Name of the group
	Name string
	// Title of the group (as used in documentation
	Title string
	// Actions contained in the group
	Actions []string
	DocEntry
}

GroupsEntry definition of group of actions

Jump to

Keyboard shortcuts

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