MarkdownTemplate class Null safety

The MarkdownTemplateBuilder will create the MarkdownTemplate for each MarkdownTemplateFile The MarkdownTemplate will put the contents of the MarkdownTemplateFile as TextNode in its children The DocumentationParser will replace this TextNode with multiple Nodes if needed. The OutputBuilder converts each MarkdownTemplate into a GeneratedMarkdownFile

Inheritance

Constructors

MarkdownTemplate({required ParentNode parent, required String sourcePath, required ProjectFilePath destinationFilePath, required Uri? destinationWebUri})

Properties

children List<Node>
final, inherited
destinationFilePath ProjectFilePath
The path to where the generated MarkdownTemplateFile needs to be stored
final
destinationWebUri Uri?
A uri to the web presentation null if it does not exits of is unknown
final
hashCode int
The hash code for this object. [...]
read-only, inherited
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
read / write, inherited
parent ParentNode?
final, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
sourceFilePath ProjectFilePath
The MarkdownTemplateFile
final

Methods

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
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited