CODEWITHSUNDEEP
flutterdartdartdoc
Mekni_Wassime
Mekni_Wassime

Reputation: 11

Is there a way to document factory method parameters in Dart?

I'm developing a package for flutter and i am trying to add documentation for it, problem is i have a couple of factory methods and i want to document the individual parameters that go into them just like we do for constructors

But i am out finding that a limitation is in place where you have to reference method parameters in the method's own doc comments which works for regular functions but i find that single parameter comments are helpful when working with widgets that other people wrote (such as the built-in flutter widgets) and i think that not having documentation for the parameters of my factory methods is detrimental to the ease of use of my package

Upvotes: 1

Views: 256

Answers (1)

Jordan Nelson
Jordan Nelson

Reputation: 1213

This is not supported by Dart. There is an open feature request for it though. If this is something you want to see supported, you can express interest for it on that feature request.

https://github.com/dart-lang/dartdoc/issues/1259

Upvotes: 0

Related Questions