[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)


synthesized attribute doEmit :: Boolean

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?


inherited attribute paramNames :: Maybe<[String]>

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.


inherited attribute isForWhat :: String

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.


inherited attribute indentBy :: String

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.


synthesized attribute paramBlocks :: [Pair<String String>]

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)


synthesized attribute otherBlocks :: [Pair<String String>]

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)


synthesized attribute configArgs :: [Pair<String ConfigValue>]

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 34.

Config args.


inherited attribute offsetLocation :: Location

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 :)

nonterminal DclComment

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 36.

(Undocumented.)


nonterminal DclCommentBlocks

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 38.

(Undocumented.)


nonterminal DclCommentStrictBlocks

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 39.

(Undocumented.)


nonterminal DclCommentBlock

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 40.

(Undocumented.)


nonterminal ConfigValue

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 42.

(Undocumented.)


nonterminal DclCommentLines

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 44.

(Undocumented.)


nonterminal DclCommentParts

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 46.

(Undocumented.)


nonterminal DclCommentPart

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 47.

(Undocumented.)


parser parseDocComment :: DclComment

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 64.

(Undocumented.)


concrete production emptyDclComment   (top::DclComment ::= EmptyDclComment_t )

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 68.

(Undocumented.)


global theEmptyDclComment

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.)


fun getBlocksNamed   ([String] ::= l::[Pair<String String>] f::String )

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.)


fun checkParams   ([String] ::= p::[String] b::[String] )

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 178.

(Undocumented.)


abstract production errorDclComment   (top::DclComment ::= content::String error::ParseError )

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.)


concrete production nilCommentBlocks   (top::DclCommentStrictBlocks ::= )

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.)


concrete production commentBlock   (top::DclCommentBlock ::= EmptyLines_t content::DclCommentLines )

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.)


concrete production hideBlock   (top::DclCommentBlock ::= Hide_t )

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.)


synthesized attribute asBool :: Maybe<Boolean>

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 330.

(Undocumented.)


synthesized attribute asString :: Maybe<String>

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 331.

(Undocumented.)


synthesized attribute asInteger :: Maybe<Integer>

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 332.

(Undocumented.)


concrete production kwdValue   (top::ConfigValue ::= v::ConfigValueKeyword_t )

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 334.

(Undocumented.)


concrete production stringValue   (top::ConfigValue ::= v::ConfigValueString_t )

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 342.

(Undocumented.)


concrete production integerValue   (top::ConfigValue ::= v::ConfigValueInt_t )

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 350.

(Undocumented.)


concrete production lastCommentLines   (top::DclCommentLines ::= body::DclCommentParts )

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.)


concrete production firstCommentParts   (top::DclCommentParts ::= part::DclCommentPart )

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.)


concrete production textCommentPart   (top::DclCommentPart ::= part::CommentContent_t )

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 387.

(Undocumented.)


concrete production linkCommentPart   (top::DclCommentPart ::= '@link' '[' id::Id_t ']' )

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 393.

(Undocumented.)


concrete production fileLinkCommentPart   (top::DclCommentPart ::= '@file' '[' path::Path_t ']' )

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 407.

(Undocumented.)


concrete production escapedAtPart   (top::DclCommentPart ::= '@@' )

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 413.

(Undocumented.)


terminal InitialIgnore_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 419.

(Undocumented.)


terminal FinalIgnore_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 421.

(Undocumented.)


terminal EmptyDclComment_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 422.

(Undocumented.)


terminal EmptyLines_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 423.

(Undocumented.)


terminal Newline_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 425.

(Undocumented.)


terminal CommentContent_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 426.

(Undocumented.)


terminal EscapedAt_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 428.

(Undocumented.)


terminal Param_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 430.

(Undocumented.)


terminal Return_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 432.

(Undocumented.)


terminal Forward_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 433.

(Undocumented.)


terminal Prodattr_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 434.

(Undocumented.)


terminal Warning_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 435.

(Undocumented.)


terminal Config_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 436.

(Undocumented.)


terminal Hide_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 437.

(Undocumented.)


terminal ConfigValueKeyword_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 438.

(Undocumented.)


terminal ConfigValueString_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 440.

(Undocumented.)


terminal ConfigValueInt_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 441.

(Undocumented.)


terminal Whitespace_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 442.

(Undocumented.)


terminal Equals_t

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.)


terminal OpenBracket_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 448.

(Undocumented.)


terminal CloseBracket_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 449.

(Undocumented.)


terminal Id_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 450.

(Undocumented.)


terminal Path_t

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 451.

(Undocumented.)


lexer class BLOCK_KWD dominates {CommentContent_t}

Contained in grammar [silver:compiler:extension:doc:core:doclang]. Defined at silver/compiler/extension/doc/core/doclang/DclComment.sv line 454.

(Undocumented.)