You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add documentation to most, or all public methods and fields using the /// comment notation, e.g.:
/// Add [x] to [y] and return the resultintadd(int x, int y) {
return x + y;
}
It would be nice to document at least 20% of the public API to satisfy pub.dev score.
The challenge is to find a way for pub.dev to ignore the generated code, or to change the way code generation works so it's no longer part of the Firedart SDK.
Ideally, doing the above will also organize the pub.dev API documentation which currently is essentially unusable.
The text was updated successfully, but these errors were encountered:
I would appreciate that. As described above, one of the issues is that the generated code represents a large part of this project and I'm not sure if there's a way to tell the tooling to ignore that (maybe it's already doing that?).
In any case documenting our public API is always welcome.
Add documentation to most, or all public methods and fields using the
///
comment notation, e.g.:It would be nice to document at least 20% of the public API to satisfy pub.dev score.
The challenge is to find a way for pub.dev to ignore the generated code, or to change the way code generation works so it's no longer part of the Firedart SDK.
Ideally, doing the above will also organize the pub.dev API documentation which currently is essentially unusable.
The text was updated successfully, but these errors were encountered: