grapher

Documentation

Overview

TODO(sqs): remove this file

Index

• Variables
• func NormalizeData(o *Output) error
• func Register(emptySourceUnit unit.SourceUnit, grapher Grapher)
• type Grapher
• type Output
  • func Graph(dir string, u *unit.SourceUnit, c *config.Repository) (*Output, error)

Variables

var Graphers = make(map[reflect.Type]Grapher)

Graphers holds all registered graphers.

Functions

func NormalizeData

func NormalizeData(o *Output) error

NormalizeData sorts data.

func Register

func Register(emptySourceUnit unit.SourceUnit, grapher Grapher)

Register sets the grapher to be used for source units of the given type. If Register is called twice with the same name or if grapher is nil, it panics

Types

type Grapher

type Grapher interface {
	Graph(dir string, unit *unit.SourceUnit, c *config.Repository) (*Output, error)
}

type Output

type Output struct {
	Symbols []*graph.Symbol `json:",omitempty"`
	Refs    []*graph.Ref    `json:",omitempty"`
	Docs    []*graph.Doc    `json:",omitempty"`
}

func Graph

func Graph(dir string, u *unit.SourceUnit, c *config.Repository) (*Output, error)

Graph uses the registered grapher (if any) to graph the source unit (whose repository is cloned to dir).