Static Properties

booleanModifiers
ctypeDisambiguator
ctypes
delimiters
delimitersInverse
flagModifiers
innerCtypes
innerTag
modifier
pathWord
signatureArgument
signatureTag
tag
typeSelector
typeSelectorWord
word

Local Values

cpath
pathDelimit
tpath

Syntax information and regular expressions used throughout doczar. Abandon all hope ye who enter here.

Static Properties

| Object booleanModifiers

Truth map of Modifier types which are considered to be simple booleans. Many of these are also "flag" modifiers.
| Object ctypeDisambiguator

Maps component type's that share delimiters to the canonical component type which owns the delimiter. Also maps canonical component types to themselves.
| Object ctypes

Simple map of valid Component types which may be used to start a new comment, to true.
| Object delimiters

Maps delimiter characters to their Component type. The ambiguous period delimiter maps to "property".
| Object delimitersInverse

Maps Component types to their delimiter characters.
| Object flagModifiers

A truthmap of modifiers which become "flags", such as @private and @const.
| Object innerCtypes

Simple map of valid Component types for inner declarations or new comments, to true.
| RegExp innerTag

Selects an inner Declaration line and the contents afterward. Groups out Component type, value type, and Component path.
| RegExp modifier

Select a Modifier line. Does not select contents afterward. Groups out Modifier type and Modifier path.
| String pathWord

String rep of a RegExp that selects an individual path word, without delimiter, potentially from among a complex path.
| RegExp signatureArgument

Selects an individual argument from a @signature Declaration.
| RegExp signatureTag

Selects an entire comment tag dedicated to a @signature Declaration.
| RegExp tag

Selects a Declaration and its entire document comment. Groups out Component type, value type, Component path, and the remaining document after the first line.
| String typeSelector

String rep of a RegExp that Selects a complex type descriptor. For example, Object[String, MyMod.FooClass]|Array[String]|undefined.
| RegExp typeSelectorWord

String rep of a RegExp that Selects a single type descriptor. For example, Object[String, MyMod.FooClass].
| RegExp word

Used for splitting paths. Groups out a delimiter/name pair.

Local Variables

| String cpath

A selector, as a String, for a standard Component path string. Stands for Component Path.
| String pathDelimit

A character class, as a String, containing all available path delimiters.
| String tpath

A selector, as a String, for either a cpath, an es6 symbol (a cpath wrapped in square brackets) or an arbitrary String wrapped in backticks. Stands for Tricky Path.

Backticks are escapable with backslash. Paired backslashes do not escape a backtick.