DocumentationFile class

Represents a documentation file. This could be a Template or an other type of file in the doc folder of a project (e.g. a picture).

Implemented types

Implementers

Constructors

DocumentationFile({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
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.
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
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
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
resetLastCompletedRuleIndexes() → void: inherited
toString() → String: A string representation of this object.
inherited