doc

Documentation

Overview

Package doc provides an API to access documentation for functions and tokens

Index

• Variables
• func DocString(rawExpr string) (string, error)

Variables

var ErrInvalid = errors.New("Invalid documentation query")

var ErrNotFound = errors.New("No documentation found")

Functions

func DocString

func DocString(rawExpr string) (string, error)

DocString returns a string containing the documentation for a given expression.

The expression is merely scanned and not parsed, looking for keywords tokens or IDENT tokens forming a function. In that last case, a function lookup is performed, yielding the documentation of that particular function.