tag_parser library Null safety

Classes

Anchor
Represents a HTML anchor point to which you can refer to with a uriToAnchor https://stackoverflow.com/questions/5319754/cross-reference-named-anchor-in-markdown
ElementFinder
ImportCodeTag
  • {ImportCodeTag file:'file_to_import.txt' title='## Code example'}
  • Imports a (none Dart) code file.
  • Attributes:
    • path= (required) A ProjectFilePath a file path that needs to be imported as a (none Dart) code example. See also ImportDartCodeTag to import Dart code
    • title= (optional) title. You can precede the title with a number of # to indicate the title level (#=chapter, ##=paragraph, ###=sub paragraph). A title can be referenced in the documentation with a Link
  • ImportCodeTagRule
    Recognizes and creates an ImportCodeTag
    ImportDartCodeTag
  • {ImportDartCodeTag file:'file_to_import.dart' title='## Dart code example'}
  • Imports a (none Dart) code file.
  • Attributes:
    • path= (required) A DartFilePath to be imported as a Dart code example. See also ImportCodeTag to import none Dart code.
    • title= (optional) title. You can precede the title with a number of # to indicate the title level (#=chapter, ##=paragraph, ###=sub paragraph). A title can be referenced in the documentation with a Link
  • ImportDartCodeTagRule
    Recognizes and creates an ImportDartCodeTag
    ImportDartDocTag
  • {ImportDartDoc path='lib\my_lib.dart|MyClass' title='## My Class'}
  • Imports Dart documentation comments from a library member in a dart file.
  • Attributes:
    • path= (required) A DartCodePath to be imported Dart comments.
    • title= (optional) title. You can precede the title with a number of # to indicate the title level (#=chapter, ##=paragraph, ###=sub paragraph). A title can be referenced in the documentation with a Link
  • ImportDartDocTagRule
    Recognizes and creates an ImportDartDocTag
    ImportFileTag
  • {ImportFile file:'OtherTemplateFile.mdt' title='## Other Template File'}
  • Imports another text file or markdown file.
  • Attributes:
    • path= (required) A ProjectFilePath to a file name inside the markdown directory that needs to be imported. This may be any type of text file (e.g. .mdt file).
    • title= (optional) title. You can precede the title with a number of # to indicate the title level (#=chapter, ##=paragraph, ###=sub paragraph). A title can be referenced in the documentation with a Link
  • ImportFileTagRule
    Recognizes and creates an ImportFileTag
    Tag
    Tags are specific texts in MarkdownTemplates that are replaced by the DocumentationBuilder with other information (e.g. by an imported Dart Documentation Comment) before the output file is written. [...]
    TagParser
    The TagParser searches for TextNode's that contain texts that represent a Tag It then replaces these TextNode's into a Tag and additional TextNode's for the remaining text.
    TagRule
    Title
    Represents a markdown title with a custom Anchor id that can be navigated to using anchor.uriToAnchor [...]
    TitleAndOrAnchor

    Constants

    groupNameAttributes → const String
    'attributes'

    Functions

    parseLibrary(ParentNode parent, ProjectFilePath dartFile) Future<LibraryElement>