finder

Documentation

Index

• type CommentConfig
• type Finder
  • func (f *Finder) Find(filename string, reader io.Reader) ([]tag.Raw, error)

Types

type CommentConfig

type CommentConfig struct {
	LineComment []string
	BlockStart  []string
	BlockEnd    []string
}

type Finder

type Finder struct {
	// CommentConfig maps the filetype (e.g. ".go") to the matching CommentConfig.
	CommentConfig map[string]CommentConfig
	// contains filtered or unexported fields
}

Finder implements the TagFinder interface in a language-generic way. It takes into account block comments (e.g. /* .... */) and line comments (e.g. // ...). You can pass alternative comment indicators to support other languages.

func (*Finder) Find

func (f *Finder) Find(filename string, reader io.Reader) ([]tag.Raw, error)