raesl.compile.typechecking.compdef_comment_builder

Deal with the comment sections in a component definition.

Module Contents

Classes

CompDefCommentBuilder

Collect the names in the 'comments' section, and hook them into the doc comments

class raesl.compile.typechecking.compdef_comment_builder.CompDefCommentBuilder(comp_child_builders: raesl.compile.typechecking.compdef_builder.CompDefChildBuilders)

Collect the names in the ‘comments’ section, and hook them into the doc comments distributor.

Parameters:

comp_child_builders – Component definition’s section builders storage.

diag_store

Diagnostics storage of component definition child builders.

name_toks

Names occurring in a comment section, collected during parsing.

add_comment(name_tok: raesl.compile.scanner.Token)

Parser found a name in a comments section, store it for future processing.

finish_comp(comp_def: raesl.compile.ast.components.ComponentDefinition, doc_distributor: raesl.compile.ast.comment_storage.DocCommentDistributor)

Process all collected names. This method should be the final step in processing a component definition, as it needs all elements that take doc comments.

Parameters:

• comp_def – Component definition to finish.

• doc_distributor – Object that distributes doc comments to interested elements of the specification.