Prepare 2.0 Beta 4 release

square · Nov 19, 2019 · 2092bc8 · 2092bc8
1 parent dac46ef
commit 2092bc8
Show file tree

Hide file tree

Showing 79 changed files with 422 additions and 39 deletions.
diff --git a/docs/api/leakcanary-android-core/leakcanary/-leak-canary/-config/-init-.md b/docs/api/leakcanary-android-core/leakcanary/-leak-canary/-config/-init-.md
@@ -2,7 +2,7 @@
 
 # &lt;init&gt;
 
-`Config(dumpHeap: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, dumpHeapWhenDebugging: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, retainedVisibleThreshold: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 5, referenceMatchers: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<ReferenceMatcher> = AndroidReferenceMatchers.appDefaults, objectInspectors: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<ObjectInspector> = AndroidObjectInspectors.appDefaults, onHeapAnalyzedListener: `[`OnHeapAnalyzedListener`](../../-on-heap-analyzed-listener/index.md)` = DefaultOnHeapAnalyzedListener.create(), computeRetainedHeapSize: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, maxStoredHeapDumps: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 7, requestWriteExternalStoragePermission: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, useExperimentalLeakFinders: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false)`
+`Config(dumpHeap: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, dumpHeapWhenDebugging: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, retainedVisibleThreshold: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 5, referenceMatchers: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<ReferenceMatcher> = AndroidReferenceMatchers.appDefaults, objectInspectors: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<ObjectInspector> = AndroidObjectInspectors.appDefaults, onHeapAnalyzedListener: `[`OnHeapAnalyzedListener`](../../-on-heap-analyzed-listener/index.md)` = DefaultOnHeapAnalyzedListener.create(), metatadaExtractor: MetadataExtractor = AndroidMetadataExtractor, computeRetainedHeapSize: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, maxStoredHeapDumps: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 7, requestWriteExternalStoragePermission: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, useExperimentalLeakFinders: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false)`
 
 LeakCanary configuration data class. Properties can be updated via [copy](#).
 

diff --git a/docs/api/leakcanary-android-core/leakcanary/-leak-canary/-config/index.md b/docs/api/leakcanary-android-core/leakcanary/-leak-canary/-config/index.md
@@ -14,7 +14,7 @@ LeakCanary configuration data class. Properties can be updated via [copy](#).
 
 | Name | Summary |
 |---|---|
-| [&lt;init&gt;](-init-.md) | `Config(dumpHeap: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, dumpHeapWhenDebugging: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, retainedVisibleThreshold: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 5, referenceMatchers: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<ReferenceMatcher> = AndroidReferenceMatchers.appDefaults, objectInspectors: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<ObjectInspector> = AndroidObjectInspectors.appDefaults, onHeapAnalyzedListener: `[`OnHeapAnalyzedListener`](../../-on-heap-analyzed-listener/index.md)` = DefaultOnHeapAnalyzedListener.create(), computeRetainedHeapSize: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, maxStoredHeapDumps: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 7, requestWriteExternalStoragePermission: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, useExperimentalLeakFinders: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false)`<br>LeakCanary configuration data class. Properties can be updated via [copy](#). |
+| [&lt;init&gt;](-init-.md) | `Config(dumpHeap: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, dumpHeapWhenDebugging: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, retainedVisibleThreshold: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 5, referenceMatchers: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<ReferenceMatcher> = AndroidReferenceMatchers.appDefaults, objectInspectors: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<ObjectInspector> = AndroidObjectInspectors.appDefaults, onHeapAnalyzedListener: `[`OnHeapAnalyzedListener`](../../-on-heap-analyzed-listener/index.md)` = DefaultOnHeapAnalyzedListener.create(), metatadaExtractor: MetadataExtractor = AndroidMetadataExtractor, computeRetainedHeapSize: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, maxStoredHeapDumps: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 7, requestWriteExternalStoragePermission: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, useExperimentalLeakFinders: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false)`<br>LeakCanary configuration data class. Properties can be updated via [copy](#). |
 
 ### Properties
 
@@ -24,6 +24,7 @@ LeakCanary configuration data class. Properties can be updated via [copy](#).
 | [dumpHeap](dump-heap.md) | `val dumpHeap: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)<br>Whether LeakCanary should dump the heap when enough retained instances are found. This needs to be true for LeakCanary to work, but sometimes you may want to temporarily disable LeakCanary (e.g. for a product demo). |
 | [dumpHeapWhenDebugging](dump-heap-when-debugging.md) | `val dumpHeapWhenDebugging: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)<br>If [dumpHeapWhenDebugging](dump-heap-when-debugging.md) is false then LeakCanary will not dump the heap when the debugger is attached. The debugger can create temporary memory leaks (for instance if a thread is blocked on a breakpoint). |
 | [maxStoredHeapDumps](max-stored-heap-dumps.md) | `val maxStoredHeapDumps: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>How many heap dumps are kept on the Android device for this app package. When this threshold is reached LeakCanary deletes the older heap dumps. As several heap dumps may be enqueued you should avoid going down to 1 or 2. |
+| [metatadaExtractor](metatada-extractor.md) | `val metatadaExtractor: MetadataExtractor`<br>Extracts metadata from a hprof to be reported in [HeapAnalysisSuccess.metadata](#). Called on a background thread during heap analysis. |
 | [objectInspectors](object-inspectors.md) | `val objectInspectors: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<ObjectInspector>`<br>List of [ObjectInspector](#) that provide LeakCanary with insights about objects found in the heap. You can create your own [ObjectInspector](#) implementations, and also add a [shark.AppSingletonInspector](#) instance created with the list of internal singletons. |
 | [onHeapAnalyzedListener](on-heap-analyzed-listener.md) | `val onHeapAnalyzedListener: `[`OnHeapAnalyzedListener`](../../-on-heap-analyzed-listener/index.md)<br>Called on a background thread when the heap analysis is complete. If you want leaks to be added to the activity that lists leaks, make sure to delegate calls to a [DefaultOnHeapAnalyzedListener](../../-default-on-heap-analyzed-listener/index.md). |
 | [referenceMatchers](reference-matchers.md) | `val referenceMatchers: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<ReferenceMatcher>`<br>Known patterns of references in the heap, lister here either to ignore them ([IgnoredReferenceMatcher](#)) or to mark them as library leaks ([LibraryLeakReferenceMatcher](#)). |

diff --git a/...i/leakcanary-android-core/leakcanary/-leak-canary/-config/metatada-extractor.md b/...i/leakcanary-android-core/leakcanary/-leak-canary/-config/metatada-extractor.md
@@ -0,0 +1,11 @@
+[leakcanary-android-core](../../../index.md) / [leakcanary](../../index.md) / [LeakCanary](../index.md) / [Config](index.md) / [metatadaExtractor](./metatada-extractor.md)
+
+# metatadaExtractor
+
+`val metatadaExtractor: MetadataExtractor`
+
+Extracts metadata from a hprof to be reported in [HeapAnalysisSuccess.metadata](#).
+Called on a background thread during heap analysis.
+
+Defaults to [AndroidMetadataExtractor](#)
+
diff --git a/docs/api/shark-android/alltypes/index.md b/docs/api/shark-android/alltypes/index.md
@@ -5,5 +5,6 @@
 | Name | Summary |
 |---|---|
 | [shark.AndroidBuildMirror](../shark/-android-build-mirror/index.md) | Caches values from the android.os.Build class in the heap dump. Retrieve a cached instances via [fromHeapGraph](../shark/-android-build-mirror/from-heap-graph.md). |
+| [shark.AndroidMetadataExtractor](../shark/-android-metadata-extractor/index.md) |  |
 | [shark.AndroidObjectInspectors](../shark/-android-object-inspectors/index.md) | A set of default [ObjectInspector](#)s that knows about common AOSP and library classes. |
 | [shark.AndroidReferenceMatchers](../shark/-android-reference-matchers/index.md) | [AndroidReferenceMatchers](../shark/-android-reference-matchers/index.md) values add [ReferenceMatcher](#) instances to a global list via their [add](#) method. A [ReferenceMatcher](#) is either a [IgnoredReferenceMatcher](#) or a [LibraryLeakReferenceMatcher](#). |
diff --git a/docs/api/shark-android/shark/-android-metadata-extractor/extract-metadata.md b/docs/api/shark-android/shark/-android-metadata-extractor/extract-metadata.md
@@ -0,0 +1,5 @@
+[shark-android](../../index.md) / [shark](../index.md) / [AndroidMetadataExtractor](index.md) / [extractMetadata](./extract-metadata.md)
+
+# extractMetadata
+
+`fun extractMetadata(graph: HeapGraph): `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>`
diff --git a/docs/api/shark-android/shark/-android-metadata-extractor/index.md b/docs/api/shark-android/shark/-android-metadata-extractor/index.md
@@ -0,0 +1,11 @@
+[shark-android](../../index.md) / [shark](../index.md) / [AndroidMetadataExtractor](./index.md)
+
+# AndroidMetadataExtractor
+
+`object AndroidMetadataExtractor : MetadataExtractor`
+
+### Functions
+
+| Name | Summary |
+|---|---|
+| [extractMetadata](extract-metadata.md) | `fun extractMetadata(graph: HeapGraph): `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` |
diff --git a/...rk/-android-reference-matchers/-a-c-c-e-s-s-i-b-i-l-i-t-y_-i-t-e-r-a-t-o-r-s.md b/...rk/-android-reference-matchers/-a-c-c-e-s-s-i-b-i-l-i-t-y_-i-t-e-r-a-t-o-r-s.md
@@ -0,0 +1,5 @@
+[shark-android](../../index.md) / [shark](../index.md) / [AndroidReferenceMatchers](index.md) / [ACCESSIBILITY_ITERATORS](./-a-c-c-e-s-s-i-b-i-l-i-t-y_-i-t-e-r-a-t-o-r-s.md)
+
+# ACCESSIBILITY_ITERATORS
+
+`ACCESSIBILITY_ITERATORS`
diff --git a/...rk-android/shark/-android-reference-matchers/-a-s-s-i-s-t_-s-t-r-u-c-t-u-r-e.md b/...rk-android/shark/-android-reference-matchers/-a-s-s-i-s-t_-s-t-r-u-c-t-u-r-e.md
@@ -0,0 +1,5 @@
+[shark-android](../../index.md) / [shark](../index.md) / [AndroidReferenceMatchers](index.md) / [ASSIST_STRUCTURE](./-a-s-s-i-s-t_-s-t-r-u-c-t-u-r-e.md)
+
+# ASSIST_STRUCTURE
+
+`ASSIST_STRUCTURE`
diff --git a/.../shark-android/shark/-android-reference-matchers/-c-h-a-n-g-e_-w-a-t-c-h-e-r.md b/.../shark-android/shark/-android-reference-matchers/-c-h-a-n-g-e_-w-a-t-c-h-e-r.md
diff --git a/...matchers/-c-o-n-t-r-o-l-l-e-d_-i-n-p-u-t_-c-o-n-n-e-c-t-i-o-n_-w-r-a-p-p-e-r.md b/...matchers/-c-o-n-t-r-o-l-l-e-d_-i-n-p-u-t_-c-o-n-n-e-c-t-i-o-n_-w-r-a-p-p-e-r.md
@@ -0,0 +1,5 @@
+[shark-android](../../index.md) / [shark](../index.md) / [AndroidReferenceMatchers](index.md) / [CONTROLLED_INPUT_CONNECTION_WRAPPER](./-c-o-n-t-r-o-l-l-e-d_-i-n-p-u-t_-c-o-n-n-e-c-t-i-o-n_-w-r-a-p-p-e-r.md)
+
+# CONTROLLED_INPUT_CONNECTION_WRAPPER
+
+`CONTROLLED_INPUT_CONNECTION_WRAPPER`
diff --git a/...droid-reference-matchers/-e-x-t-e-n-d-e-d_-s-t-a-t-u-s_-b-a-r_-m-a-n-a-g-e-r.md b/...droid-reference-matchers/-e-x-t-e-n-d-e-d_-s-t-a-t-u-s_-b-a-r_-m-a-n-a-g-e-r.md
@@ -0,0 +1,5 @@
+[shark-android](../../index.md) / [shark](../index.md) / [AndroidReferenceMatchers](index.md) / [EXTENDED_STATUS_BAR_MANAGER](./-e-x-t-e-n-d-e-d_-s-t-a-t-u-s_-b-a-r_-m-a-n-a-g-e-r.md)
+
+# EXTENDED_STATUS_BAR_MANAGER
+
+`EXTENDED_STATUS_BAR_MANAGER`
diff --git a/...k/-android-reference-matchers/-i-r-e-q-u-e-s-t_-f-i-n-i-s-h_-c-a-l-l-b-a-c-k.md b/...k/-android-reference-matchers/-i-r-e-q-u-e-s-t_-f-i-n-i-s-h_-c-a-l-l-b-a-c-k.md
@@ -0,0 +1,5 @@
+[shark-android](../../index.md) / [shark](../index.md) / [AndroidReferenceMatchers](index.md) / [IREQUEST_FINISH_CALLBACK](./-i-r-e-q-u-e-s-t_-f-i-n-i-s-h_-c-a-l-l-b-a-c-k.md)
+
+# IREQUEST_FINISH_CALLBACK
+
+`IREQUEST_FINISH_CALLBACK`
diff --git a/.../shark/-android-reference-matchers/-o-e-m_-s-c-e-n-e_-c-a-l-l_-b-l-o-c-k-e-r.md b/.../shark/-android-reference-matchers/-o-e-m_-s-c-e-n-e_-c-a-l-l_-b-l-o-c-k-e-r.md
@@ -0,0 +1,5 @@
+[shark-android](../../index.md) / [shark](../index.md) / [AndroidReferenceMatchers](index.md) / [OEM_SCENE_CALL_BLOCKER](./-o-e-m_-s-c-e-n-e_-c-a-l-l_-b-l-o-c-k-e-r.md)
+
+# OEM_SCENE_CALL_BLOCKER
+
+`OEM_SCENE_CALL_BLOCKER`
diff --git a/docs/api/shark-android/shark/-android-reference-matchers/-o-n-e_-p-l-u-s.md b/docs/api/shark-android/shark/-android-reference-matchers/-o-n-e_-p-l-u-s.md
@@ -0,0 +1,5 @@
+[shark-android](../../index.md) / [shark](../index.md) / [AndroidReferenceMatchers](index.md) / [ONE_PLUS](./-o-n-e_-p-l-u-s.md)
+
+# ONE_PLUS
+
+`const val ONE_PLUS: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
diff --git a/docs/api/shark-android/shark/-android-reference-matchers/-s-h-a-r-p.md b/docs/api/shark-android/shark/-android-reference-matchers/-s-h-a-r-p.md
@@ -0,0 +1,5 @@
+[shark-android](../../index.md) / [shark](../index.md) / [AndroidReferenceMatchers](index.md) / [SHARP](./-s-h-a-r-p.md)
+
+# SHARP
+
+`const val SHARP: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
diff --git a/docs/api/shark-android/shark/-android-reference-matchers/-t-o-a-s-t_-t-n.md b/docs/api/shark-android/shark/-android-reference-matchers/-t-o-a-s-t_-t-n.md
@@ -0,0 +1,5 @@
+[shark-android](../../index.md) / [shark](../index.md) / [AndroidReferenceMatchers](index.md) / [TOAST_TN](./-t-o-a-s-t_-t-n.md)
+
+# TOAST_TN
+
+`TOAST_TN`
diff --git a/...d/shark/-android-reference-matchers/-w-i-n-d-o-w_-m-a-n-a-g-e-r_-g-l-o-b-a-l.md b/...d/shark/-android-reference-matchers/-w-i-n-d-o-w_-m-a-n-a-g-e-r_-g-l-o-b-a-l.md
@@ -0,0 +1,5 @@
+[shark-android](../../index.md) / [shark](../index.md) / [AndroidReferenceMatchers](index.md) / [WINDOW_MANAGER_GLOBAL](./-w-i-n-d-o-w_-m-a-n-a-g-e-r_-g-l-o-b-a-l.md)
+
+# WINDOW_MANAGER_GLOBAL
+
+`WINDOW_MANAGER_GLOBAL`