Skip to content

Commit

Permalink
Improve doc comments. (#100)
Browse files Browse the repository at this point in the history
  • Loading branch information
polina-c committed Jul 21, 2023
1 parent 6e3f57c commit 3a061a4
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions pkgs/leak_tracker/lib/src/leak_tracking/orchestration.dart
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
/// 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

0 comments on commit 3a061a4

Please sign in to comment.