package
0.0.0-20210930170514-bc7ee3adfb11
Repository: https://github.com/b5/outline.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author
Parse consumes a reader of data that contains zero or more outlines creating and returning any documents it finds.
ParseFirst consumes a reader of outline data, creating and returning the first outline document it encounters.

# Constants

CodeTok is the "code:" token.
DocumentTok is the "document:" token.
ExamplesTok is the "examples:" token.
FieldsTok is the "fields:" token.
FunctionsTok is the "functions:" token.
IllegalTok is the default for unrecognized tokens.
IndentTok is a tab character "\t" or two consecutive spaces" ".
KeywordBegin marks the end of keyword tokens in the token enumeration.
KeywordEnd marks the end of keyword tokens in the token enumeration.
LiteralBegin marks the beginning of literal tokens in the token enumeration.
LiteralEnd marks the end of literal tokens in the token enumeration.
MethodsTok is the "methods:" token.
NewlineTok is a line break.
OperatorsTok is the "operators:" token.
ParamsTok is the "params:" token.
PathTok is the "path:" token.
ReturnTok is the "return:" token.
TextTok is a token for arbitrary text.
TypesTok is the "types:" token.

# Structs

Doc is is a documentation document.
No description provided by the author
Field is a property of a constructed Type.
Function documents a starlark function.
Operator documents boolean operation on a constructed type.
Param is an argument to a function.
Position of a token within the scan stream.
Token is a recognized token from the outlineline lexicon.
Type documents a constructed type.

# Interfaces

No description provided by the author

# Type aliases

Docs is a sortable slice of Doc pointers.
Functions is a sortable slice of Function pointers.
TokenType enumerates the different types of tokens.
Types is a sortable slice of Type pointers.