gendoc

Documentation

Index

• func FileOptions(f *ast.File) ([]interface{}, error)
• func Options(pkgs []*packages.Package) ([]interface{}, error)
• type Cell
  • func (c Cell) BucketFormat() string
  • func (c Cell) Description() string
  • func (c Cell) Field(f Field) string
  • func (c Cell) Labels() string
  • func (c Cell) Name() string
  • func (c Cell) Type() string
• type Cells
  • func NewCells(options []interface{}) (Cells, error)
  • func (c Cells) Len() int
  • func (c Cells) Less(i, j int) bool
  • func (c Cells) MaxLen(f Field) int
  • func (c Cells) Swap(i, j int)
• type Column
• type Field
• type Table
  • func NewPrometheusTable(cells Cells) Table
  • func NewStatsdTable(cells Cells) Table
  • func (t Table) Generate(w io.Writer)

Functions

func FileOptions

func FileOptions(f *ast.File) ([]interface{}, error)

func Options

func Options(pkgs []*packages.Package) ([]interface{}, error)

Types

type Cell

type Cell struct {
	// contains filtered or unexported fields
}

func (Cell) BucketFormat

func (c Cell) BucketFormat() string

func (Cell) Description

func (c Cell) Description() string

func (Cell) Field

func (c Cell) Field(f Field) string

func (Cell) Labels

func (c Cell) Labels() string

func (Cell) Name

func (c Cell) Name() string

func (Cell) Type

func (c Cell) Type() string

type Cells

type Cells []Cell

func NewCells

func NewCells(options []interface{}) (Cells, error)

func (Cells) Len

func (c Cells) Len() int

func (Cells) Less

func (c Cells) Less(i, j int) bool

func (Cells) MaxLen

func (c Cells) MaxLen(f Field) int

func (Cells) Swap

func (c Cells) Swap(i, j int)

type Column

type Column struct {
	Field Field
	Name  string
	Width int
}

type Field

type Field uint8

const (
	Name        Field = iota //名称是仪表名称。
	Type                     //
	Description              //
	Labels                   //
	Bucket                   //
)

type Table

type Table struct {
	Columns []Column
	Cells   Cells
}

func NewPrometheusTable

func NewPrometheusTable(cells Cells) Table

func NewStatsdTable

func NewStatsdTable(cells Cells) Table

func (Table) Generate

func (t Table) Generate(w io.Writer)