Template class

The DocumentationModelBuilder will create the Template for each TemplateFile The Template will put the contents of the TemplateFile as TextNode in its children The DocumentationParser will replace this TextNode with multiple Nodes if needed. The OutputBuilder converts each Template into a GeneratedFile

Inheritance

Implementers

Constructors

Template({required ParentNode parent, required ProjectFilePath sourceFilePath, required ProjectFilePath destinationFilePath, Uri? destinationWebUri})

children → List<Node>: finalinherited
destinationFilePath → ProjectFilePath: The path to where the generated TemplateFile needs to be stored
finalinherited
destinationWebUri → Uri?: A uri to the web presentation null if it does not exits of is unknown
finalinherited
hashCode → int: The hash code for this object.
no setterinherited
lastCompletedRuleIndex ↔ int: A ParserRule is done when its ParserRule.findChildNodesToReplace method can no longer find children to replace. -1 = no ParserRules are done: they still all need to check if they can find children to replace 0 = the first ParserRule is done: - it did not find any children to replace - the remaining rules (if any) still need to check if they can find children to replace 1 = the first 2 ParserRules are done: - they did not find any children to replace - the remaining rules (if any) still need to check if they can find children to replace etc
getter/setter pairinherited
parent → ParentNode?: finalinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
sourceFilePath → ProjectFilePath: The documentation file
finalinherited
title → String: final

compareTo(dynamic other) → int: Orders wiki pages first.
override
findChildren<T>() → List<T>: Finds all children (or children's children) of a given Type
inherited
findNodeWithUncompletedRule(int ruleIndex) → ParentNode?: Find a ParentNode that still needs to check the given rule
inherited
findParent<T>() → T?: Finds the first parent of a given Type
inherited
hasWebUriAndFileEndsWith(String path) → dynamic
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
readSourceFileText(ProjectFilePath sourcePath) → String
resetLastCompletedRuleIndexes() → void: inherited
thisFileWasGeneratedComment(ProjectFilePath sourcePath) → String
toString() → String: A string representation of this object.
inherited