token

Documentation

Overview

Package token handles tokenization of the raw API documentation lines.

Index

• type Parser
  • func NewParser(verbose bool) Parser
• type Token
• type Type

Types

type Parser

type Parser interface {
	// Parse the raw extracted blocks into tokens
	Parse(b extract.Block) ([]Token, error)
}

Parser of the tokens

func NewParser

func NewParser(verbose bool) Parser

NewParser instance

type Token

type Token struct {
	Type Type
	Key  string
	Meta map[string]string
}

Token produced by the tokenization process.

Meta is a collection of all found and expected token meta properties defined by token dictionary.

type Type

type Type uint8

Type of the token from parsing perspective, i.e. shared dictionires

const (
	Value Type = iota
	Param
	Server
	ReqResp
	Router
	Ref
	Wrap
)

Token types