annotations

Documentation

Overview

Package annotations makes it possible to track use of resource annotations within a procress in order to generate documentation for these uses.

Index

• func RegisterFull(a Annotation)
• type Annotation
  • func Descriptions() []Annotation
  • func Register(name string, description string) Annotation

Functions

func RegisterFull

func RegisterFull(a Annotation)

RegisterFull registers a new annotation.

Types

type Annotation

type Annotation struct {
	// The name of the annotation.
	Name string

	// Description of the annotation.
	Description string

	// Hide the existence of this annotation when outputting usage information.
	Hidden bool

	// Mark this annotation as deprecated when generating usage information.
	Deprecated bool
}

Annotation describes a single resource annotation

func Descriptions

func Descriptions() []Annotation

Returns a description of this process' annotations, sorted by name.

func Register

func Register(name string, description string) Annotation

Register registers a new annotation.