[silver:compiler:extension:doc:core]
Contents of [silver:compiler:extension:doc:core]
:
Defined in this grammar:
Contained in grammar [silver:compiler:extension:doc:core]
. Defined at silver/compiler/extension/doc/core/DocumentedAGDcl.sv line 16.
Parameterconf
Global compiler config, used to see if any of the doc-related options are set. If none are, comment is not parsed
Parameterbody
The Doc-comment token.
Return
If we are parsing docs, the actual doc-comment parsed into a DclComment (which could be an errorDclComment) or if we aren’t then theEmptyDclComment.
Parse the doc-comment mini language in a DocComment_t, returning a DclComment.
Contained in grammar [silver:compiler:extension:doc:core]
. Defined at silver/compiler/extension/doc/core/DocumentedAGDcl.sv line 45.
Forward
Forwards to the wrapped AGDcl.
This wraps an AGDcl to allow it to be prefixed with a doc comment. AGDcls will by default emit an doc item that notes that it is undocumented (via mkUndocumentedItem.) This does not pass those up, since they are documented here.
Contained in grammar [silver:compiler:extension:doc:core]
. Defined at silver/compiler/extension/doc/core/DocumentedAGDcl.sv line 91.
Forward
emptyAGDcl.
Doc comment without associated AGDcl.
Contained in grammar [silver:compiler:extension:doc:core]
. Defined at silver/compiler/extension/doc/core/TypeClassDcls.sv line 7.
What to prefix ‘child’ declaration names with in docs and for hyperlinking.
fun toSplitFiles
([Pair<String String>] ::= g::Decorated Grammar with {decorate, downDocConfig} grammarConf::[DocConfigSetting] forIndex::[CommentItem] soFar::[Pair<String String>]
)
Contained in grammar [silver:compiler:extension:doc:core]
. Defined at silver/compiler/extension/doc/core/RootSpec.sv line 42.
Turn the files in a grammar into zero or more single-file docs pages, and collect the rest of the docs (possibly zero) into the index file.
Contained in grammar [silver:compiler:extension:doc:core]
. Defined at silver/compiler/extension/doc/core/DocConfig.sv line 7.
Represents a single setting (key = value) of a doc configuration option. Some are file-scope, and some are grammar-scope (see fileScope at silver:compiler:extension:doc:core/DocConfig.sv#23.)
Contained in grammar [silver:compiler:extension:doc:core]
. Defined at silver/compiler/extension/doc/core/DocConfig.sv line 23.
Is this DocConfigSetting at silver:compiler:extension:doc:core/DocConfig.sv#7 local to the file (e.g. @title) or to the grammar (e.g. @grammarTitle)?
Contained in grammar [silver:compiler:extension:doc:core]
. Defined at silver/compiler/extension/doc/core/Root.sv line 11.
Used for getting doc comments on AGDcls to emit. Note that not every item really should be emitted, see doEmit.
Doc config is managed in both a per-file, and per-grammar way. Directives are either file-scope
or grammar-scope. A file-scoped directive for the same setting beats a grammar-scoped one. To do
this, directives flow up via upDocConfig at silver:compiler:extension:doc:core/Root.sv#26 from AGDcls to reach grammarRootSpec
and
then flow back down via downDocConfig at silver:compiler:extension:doc:core/Root.sv#23. However, when passing through Root
the only
doc directives that flow up to the Grammar scope are those with .fileScope = true. Then when
flowing back down, those with .fileScope = false are re-added in front of grammar scope directives
in downDocConfig at silver:compiler:extension:doc:core/Root.sv#23 (and stored on the Root
as localDocConfig at silver:compiler:extension:doc:core/Root.sv#29.)
Contained in grammar [silver:compiler:extension:doc:core]
. Defined at silver/compiler/extension/doc/core/Root.sv line 23.
Final doc config flowing back down, inside files (Roots) will include file scoped settings first.
Contained in grammar [silver:compiler:extension:doc:core]
. Defined at silver/compiler/extension/doc/core/Root.sv line 26.
Doc config information flowing up. File scoped settings are stripped at the Root level.
Contained in grammar [silver:compiler:extension:doc:core]
. Defined at silver/compiler/extension/doc/core/Root.sv line 29.
Snapshot of downDocConfig at silver:compiler:extension:doc:core/Root.sv#23 stored on Root
.
Contained in grammar [silver:compiler:extension:doc:core]
. Defined at silver/compiler/extension/doc/core/Root.sv line 38.
Declarations of documented AGDcls, flowing up. Used for linking and counting documented items. Flows back down as docEnv at silver:compiler:extension:doc:core/Root.sv#41.
Contained in grammar [silver:compiler:extension:doc:core]
. Defined at silver/compiler/extension/doc/core/Root.sv line 41.
Environment of all documented AGDcls, flowing back down after being computed from docDcls at silver:compiler:extension:doc:core/Root.sv#38.
Contained in grammar [silver:compiler:extension:doc:core]
. Defined at silver/compiler/extension/doc/core/Root.sv line 46.
Errors arising from ill-formed doc comments.
Contained in grammar [silver:compiler:extension:doc:core]
. Defined at silver/compiler/extension/doc/core/Root.sv line 53.
All file names in a grammar, paired with their documentation-related error messages.
WARNING!
INTENDED TO BE INTERFERED WITH like .pp.
WARNING!
INTENDED TO BE INTERFERED WITH like .pp.