[silver:compiler:extension:doc:core:doclang]
Contents of [silver:compiler:extension:doc:core:doclang]
:
Defined in this grammar:
Comment is sequence of blocks
Blocks start with a newline or a @param/@return/@prodattr/@forward/…
Initial block is a ‘normal’ block even if no newline (but is other type if has @tag)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 16.
Does this doc comment actually result in a markdown block?
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 19.
List of parameter/child names used to warn for incorrect number/names on function/production blocks.
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 22.
Enum-like description of what type of construct the comment occurs on, used to warn on using irrelevant blocks.
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 25.
String to prepend to emitted markdown lines.
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 28.
List of pair of (paramname, content)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 31.
List of pair of (blocktype, content)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 34.
Config args.
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 56.
The location of the terminal whose text was parsed to create this DclComment, used when displaying errors.
Most of the complexity in terminals here is to allow bullet point lists and nested comments. Be careful :)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 36.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 38.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 39.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 40.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 42.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 44.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 46.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 47.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 64.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 68.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 77.
(Undocumented.)
concrete production normalDclComment
(top::DclComment ::= InitialIgnore_t blocks::DclCommentBlocks FinalIgnore_t
)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 79.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 129.
(Undocumented.)
function processConfigOptions
(Pair<[String] [DocConfigSetting]> ::= alreadyErrs::[String] args::[Pair<String ConfigValue>] conf::[DocConfigSetting]
)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 132.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 178.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 185.
(Undocumented.)
concrete production initialCommentBlocks
(top::DclCommentBlocks ::= block::DclCommentLines blocks::DclCommentStrictBlocks
)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 214.
(Undocumented.)
concrete production passThruCommentBlocks
(top::DclCommentBlocks ::= blocks::DclCommentStrictBlocks
)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 223.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 233.
(Undocumented.)
concrete production consCommentBlocks
(top::DclCommentStrictBlocks ::= block::DclCommentBlock rest::DclCommentStrictBlocks
)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 241.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 252.
(Undocumented.)
concrete production paramBlock
(top::DclCommentBlock ::= Param_t Whitespace_t id::Id_t Whitespace_t content::DclCommentLines
)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 261.
(Undocumented.)
concrete production prodattrBlock
(top::DclCommentBlock ::= Prodattr_t Whitespace_t id::Id_t Whitespace_t content::DclCommentLines
)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 270.
(Undocumented.)
concrete production returnBlock
(top::DclCommentBlock ::= Return_t Whitespace_t content::DclCommentLines
)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 279.
(Undocumented.)
concrete production forwardBlock
(top::DclCommentBlock ::= Forward_t Whitespace_t content::DclCommentLines
)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 288.
(Undocumented.)
concrete production warningBlock
(top::DclCommentBlock ::= Warning_t Whitespace_t content::DclCommentLines
)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 297.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 306.
(Undocumented.)
concrete production configBlock
(top::DclCommentBlock ::= Config_t Whitespace_t param::Id_t Whitespace_t Equals_t Whitespace_t value::ConfigValue
)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 314.
(Undocumented.)
concrete production configBlockImplicitTrue
(top::DclCommentBlock ::= Config_t Whitespace_t param::Id_t Whitespace_t
)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 323.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 330.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 331.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 332.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 334.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 342.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 350.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 358.
(Undocumented.)
concrete production consCommentLines
(top::DclCommentLines ::= body::DclCommentParts Newline_t rest::DclCommentLines
)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 364.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 374.
(Undocumented.)
concrete production snocCommentParts
(top::DclCommentParts ::= rest::DclCommentParts part::DclCommentPart
)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 380.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 387.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 393.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 407.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 413.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 419.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 421.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 422.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 423.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 425.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 426.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 428.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 430.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 432.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 433.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 434.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 435.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 436.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 437.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 438.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 440.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 441.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 442.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 444.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 445.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 447.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 448.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 449.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 450.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 451.
(Undocumented.)
Contained in grammar [silver:compiler:extension:doc:core:doclang]
. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 454.
(Undocumented.)