Summary class
Constructors
- Summary({SummaryFilePath? filePath})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addBreak(
) → void -
Adds an HTML line break (
) to the summary buffer. -
addCodeBlock(
String codeblock, [String? lang]) → void -
Adds an HTML
codeblockto the summary buffer. -
addDetails(
String label, String content) → void - Adds a collapsible HTML details element to the summary buffer.
-
addEOL(
) → void - Adds the operating system-specific end-of-line marker to the buffer.
-
addHeading(
String text, {int level = 1}) → void - Adds an HTML section heading element.
-
addImage(
String src, String alt, {SummaryImageOptions? options}) → void - Adds an HTML image tag to the summary buffer.
-
addLink(
String text, String href) → void - Adds an HTML anchor tag to the summary buffer.
-
addList(
Iterable< String> items, {bool ordered = false}) → void -
Adds an HTML
itemslist to the summary buffer. -
addQuote(
String text, {String? citation}) → void - Adds an HTML blockquote to the summary buffer.
-
addRaw(
String text, {bool addEOL = false}) → void -
Adds raw
textto the summary buffer -
addSeparator(
) → void - Adds an HTML thematic break (
-
addTable(
Iterable< Iterable< rows) → voidSummaryTableCell> > - Adds an HTML table to the summary buffer.
-
clear(
) → void - Clears the summary buffer and wipes the summary file.
-
emptyBuffer(
) → void - Resets the summary buffer without writing to summary file.
-
isEmptyBuffer(
) → bool - If the summary buffer is empty.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
Returns the current summary buffer as a string.
override
-
write(
{bool overwrite = false}) → void - Writes text in the buffer to the summary buffer file and empties buffer.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited