quick.flutter icon indicating copy to clipboard operation
quick.flutter copied to clipboard

[quick_usb] Documentation?

Open gabrc52 opened this issue 3 years ago • 4 comments

The methods and members don't seem to be documented. It'd be helpful for users of this package to have documentation.

In particular, I'd like to know what identifier and configurationCount of UsbDevice are.

gabrc52 avatar Jul 27 '22 03:07 gabrc52

If no one is doing it. Can i do it. If then can you please elaborate. Thank you

hemanthkotaprolu avatar Jul 27 '22 03:07 hemanthkotaprolu

I mean in the code, the docstrings or comments starting with /// above each class and member or method explaining what each thing is.

There is some documentation in the readme, which I'm currently using.

gabrc52 avatar Jul 27 '22 03:07 gabrc52

Just add comments to the code whenever required. Is that what you mean?

hemanthkotaprolu avatar Jul 27 '22 03:07 hemanthkotaprolu

PR welcome!

Sunbreak avatar Jul 27 '22 03:07 Sunbreak