matcher

Documentation

Overview

Implementation to find the string that will be the overview from the code or Markdown.

Index

• Constants
• Variables
• type GodocMatcher
  • func (m *GodocMatcher) Match(codes, comments []string) (string, error)
• type MarkdownMatcher
  • func (m *MarkdownMatcher) Match(codes, comments []string) (string, error)
• type Matcher
  • func NewGodocMatcher() (Matcher, error)
  • func NewMarkdownHeadingMatcher() (Matcher, error)
  • func NewMarkdownMatcher() (Matcher, error)
  • func NewRegexpMatcher(expr string) (Matcher, error)
• type RegexpMatcher
  • func (m *RegexpMatcher) Match(codes, comments []string) (string, error)

Constants

const (
	Markdown        = "markdown"
	MarkdownHeading = "markdownHeading"
	Godoc           = "godoc"
)

Variables

var MatcherMap = map[string]func() (Matcher, error){
	"markdown":        NewMarkdownMatcher,
	"markdownHeading": NewMarkdownHeadingMatcher,
	"godoc":           NewGodocMatcher,
}

Types

type GodocMatcher

type GodocMatcher struct{}

func (*GodocMatcher) Match

func (m *GodocMatcher) Match(codes, comments []string) (string, error)

type MarkdownMatcher

type MarkdownMatcher struct{}

func (*MarkdownMatcher) Match

func (m *MarkdownMatcher) Match(codes, comments []string) (string, error)

type Matcher

type Matcher interface {
	Match(codes, comments []string) (string, error)
}

func NewGodocMatcher

func NewGodocMatcher() (Matcher, error)

func NewMarkdownHeadingMatcher

func NewMarkdownHeadingMatcher() (Matcher, error)

func NewMarkdownMatcher

func NewMarkdownMatcher() (Matcher, error)

func NewRegexpMatcher

func NewRegexpMatcher(expr string) (Matcher, error)

type RegexpMatcher

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

func (*RegexpMatcher) Match

func (m *RegexpMatcher) Match(codes, comments []string) (string, error)