Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve doc comments. #100

Merged
merged 2 commits into from
Jul 21, 2023
Merged

Improve doc comments. #100

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e099ab
Update orchestration.dart
polina-c Jul 21, 2023
0515166
Update orchestration.dart
polina-c Jul 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions pkgs/leak_tracker/lib/src/leak_tracking/orchestration.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,13 @@ class MemoryLeaksDetectedError extends StateError {
/// to wait infinitely for the forced garbage collection, that is needed
/// to analyse results.
///
/// [gcCountBuffer] is number of full GC cycles, enough for a non reachable object to be GCed.
///
/// [gcCountBuffer] is number of full GC cycles, that should be enough for
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the explanation! I guess, I am still confused by what the "Buffer" in the name is supposed to mean. Would this be more appropriately named "gcCycleCount" of "numberOfGcCycles"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point. Will rename. It will be breaking change, but it is ok while leak tracker is work in progress.

/// a non reachable object to be GCed.
/// If after this number of GC cycles a disposed object is still not garbage collected,
/// it is considered a notGCed leak.
/// Theoretically, the value 1 should be enough, but in practice it creates false
/// positives for stale applications.
/// So, recommended value for applications is 3, and for tests is 1.
///
/// If you test Flutter widgets, connect their instrumentation to the leak
/// tracker:
Expand Down