Digs document comments out of source files, splits them into Declarations and Modifiers, then
reports everything it finds to a ComponentCache
instance.
Modules
Represents a single block of markdown text and wraps it with its context to ensure proper crosslinking.
The same markdown doc is often rendered twice, once in a parent context and again on the
Component's own page. To make generated docs compatible with local file view, either all links
must be local paths or the entire page must be initialized to root with a <base>
. Because
doczar
chooses to use local links, the href
for a given path changes between rendering
contexts. This necessitates multiple rendering passes and therefor the link context must be
passed forward.
Represents a type slotted into a generic/template type.
Represents a modifier declaration.
Paths are represented as Arrays of Arrays, each child Array representing the individual portions
of a fragement path. That is, the delimiter, the String fragment name, and in the case that the
fragment is an es6 symbol a third child contains another Path
representing the parsed form of
the fragment name. Examplia gratia:
[ [ ".", "name" ], ...]
Or with a symbol:
[ [ ".", "Symbols.iterator", [ [ ".", "Symbols" ], [ ".", "iterator" ] ] ]
An intermediate structure for data hot off the Parser
and ready to integrate into a
Component
. Encapsulates information included in a single declaration or
inner declaration.
Represents a value type.
Static Functions
Submit every Modifier and Declaration in a single source file to a ComponentCache
instance.
Arguments
Parsed information will be reported
to this ComponentCache
instance.
Convert a path String to a path Array. If no path is generated, [ [ ] ]
is returned. This is
because all paths have a length but the final element may be filled contextually rather than
explicitly.
Arguments
Returns
Returns Arrays of path fragment Arrays. These are of the form [ [ ".", "name" ], ...]
or when
Symbols are used, [ [ ".", "Symbols.iterator", [ [ ".", "Symbols" ], [ ".", "iterator" ] ] ]
.