gocode

Documentation

Index

• func NewDocMap(fset *token.FileSet, file *ast.File) map[ast.Node]*ast.CommentGroup
• type GoStruct
  • func (s *GoStruct) GetAnnotation(key string) string
• type Package
  • func LoadPackage(goPackage string, path string) (*Package, error)
  • func LoadPackageTree(goPackage string, basePath string) ([]*Package, error)
  • func (p *Package) GetAnnotation(key string) string
• type StructField

Functions

func NewDocMap

func NewDocMap(fset *token.FileSet, file *ast.File) map[ast.Node]*ast.CommentGroup

NewDocMap creates a map associating AST nodes (structs and fields) with their documentation comments that are immediately above them.

Types

type GoStruct

type GoStruct struct {
	GoPackage string
	Name      string
	Fields    []*StructField

	Comments []string
}

func (*GoStruct) GetAnnotation

func (s *GoStruct) GetAnnotation(key string) string

type Package

type Package struct {
	GoPackage string
	SourceDir string

	Structs []*GoStruct

	Comments []string
}

func LoadPackage

func LoadPackage(goPackage string, path string) (*Package, error)

func LoadPackageTree

func LoadPackageTree(goPackage string, basePath string) ([]*Package, error)

func (*Package) GetAnnotation

func (p *Package) GetAnnotation(key string) string

type StructField

type StructField struct {
	Name string
	Type string
}