Reputation: 2900
I'm developing a flutter package wherein I want to add docs for widget's parameters like this,
I'm referring to the description of the widget and it's parameters!
Upvotes: 1
Views: 1039
Reputation: 1555
You can comment using the ///
. For more information, reference the Effective Dart: Documentation#doc-comments.
/// This function is ~~~
///
/// The [num] must be non-null ~~
void simpleFunction(int num) {
}
Upvotes: 4