amap

Documentation

Overview

Package amap provides the functions to expand a token using the AMAP algorithm.

Index

• func Expand(token string, scope TokenScope, referenceText []string) []string
• type TokenScope
  • func NewTokenScope(variableDeclarations []string, methodName string, methodBodyText string, ...) TokenScope

Functions

func Expand

func Expand(token string, scope TokenScope, referenceText []string) []string

Expand on AMAP receives a token and returns and array of possible expansions.

The AMAP expansion algorithm handles single-word and multi-word abbreviations. For each type of abbreviation AMAP creates and applies a pattern to look for possible expansions. AMAP is capable of select the more appropriate expansions based on available information on the given context.

Types

type TokenScope

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

TokenScope represents the elements on the scoped-approach for the AMAP expander.

func NewTokenScope

func NewTokenScope(variableDeclarations []string, methodName string, methodBodyText string,
	methodComments []string, packageComments []string) TokenScope

NewTokenScope creates a new token scope.