gog

Documentation

Index

• Variables
• type Def
• type DefKey
  • func (s *DefKey) String() string
• type Doc
• type Output
  • func Graph(fset *token.FileSet, files []*ast.File, typesPkg *types.Package, ...) *Output
  • func (o *Output) Append(o2 *Output)
• type Ref

Variables

var Default = loader.Config{
	TypeChecker: types.Config{FakeImportC: true},
	Build:       &build.Default,
	AllowErrors: true,
}

Types

type Def

type Def struct {
	Name string

	*DefKey

	File      string
	IdentSpan [2]uint32
	DeclSpan  [2]uint32

	definfo.DefInfo
}

type DefKey

type DefKey struct {
	PackageImportPath string
	Path              []string
}

func (*DefKey) String

func (s *DefKey) String() string

type Doc

type Doc struct {
	*DefKey

	Unit   string
	Format string
	Data   string

	File string    `json:",omitempty"`
	Span [2]uint32 `json:",omitempty"`
}

type Output

type Output struct {
	Defs []*Def
	Refs []*Ref
	Docs []*Doc
}

func Graph

func Graph(fset *token.FileSet, files []*ast.File, typesPkg *types.Package, typesInfo *types.Info, includeDocs bool) *Output

func (*Output) Append

func (o *Output) Append(o2 *Output)

type Ref

type Ref struct {
	Unit string
	File string
	Span [2]uint32
	Def  *DefKey

	// IsDef is true if ref is to the definition of Def, and false if it's to a
	// use of Def.
	IsDef bool
}