Generate DartDoc for Function

Stay organized with collections Save and categorize content based on your preferences.

Create a DartDoc comment that could describe this function in the current file:

$SELECTION

The comment should consist of a single sentence describing what the function does, followed by a line of whitespace, and then zero or more additional sentences.
If the function takes parameters, include a sentence to describe them.
Do not include a sentence for parameters if there are no parameters.
If the function has a return type other than void, include a sentence describing what kind of value is returned and why.
If the function has side effects, include a sentence describing them.

Use a line length of 80 characters.