Prepare 2.8 release

docs/api/index.md

@@ -0,0 +1,9 @@
+//[plumber-android-core](index.md)
+
+# plumber-android-core
+
+## Packages
+
+| Name |
+|---|
+| [leakcanary](plumber-android-core/leakcanary/index.md) |

docs/api/leakcanary-android-core/leakcanary/-android-debug-heap-dumper/dump-heap.md

@@ -0,0 +1,10 @@
+//[leakcanary-android-core](../../../index.md)/[leakcanary](../index.md)/[AndroidDebugHeapDumper](index.md)/[dumpHeap](dump-heap.md)
+
+# dumpHeap
+
+[androidJvm]\
+open override fun [dumpHeap](dump-heap.md)(heapDumpFile: [File](https://developer.android.com/reference/kotlin/java/io/File.html))
+
+Dumps the heap. The implementation is expected to be blocking until the heap is dumped or heap dumping failed.
+
+Implementations can throw a runtime exception if heap dumping failed.

docs/api/leakcanary-android-core/leakcanary/-android-debug-heap-dumper/index.md

@@ -0,0 +1,16 @@
+//[leakcanary-android-core](../../../index.md)/[leakcanary](../index.md)/[AndroidDebugHeapDumper](index.md)
+
+# AndroidDebugHeapDumper
+
+[androidJvm]\
+object [AndroidDebugHeapDumper](index.md) : [HeapDumper](../-heap-dumper/index.md)
+
+Dumps the Android heap using [Debug.dumpHprofData](https://developer.android.com/reference/kotlin/android/os/Debug.html#dumphprofdata).
+
+Note: despite being part of the Debug class, [Debug.dumpHprofData](https://developer.android.com/reference/kotlin/android/os/Debug.html#dumphprofdata) can be called from non debuggable non profileable builds.
+
+## Functions
+
+| Name | Summary |
+|---|---|
+| [dumpHeap](dump-heap.md) | [androidJvm]<br>open override fun [dumpHeap](dump-heap.md)(heapDumpFile: [File](https://developer.android.com/reference/kotlin/java/io/File.html))<br>Dumps the heap. The implementation is expected to be blocking until the heap is dumped or heap dumping failed. |

docs/api/leakcanary-android-core/leakcanary/-background-thread-heap-analyzer/index.md

@@ -0,0 +1,14 @@
+//[leakcanary-android-core](../../../index.md)/[leakcanary](../index.md)/[BackgroundThreadHeapAnalyzer](index.md)
+
+# BackgroundThreadHeapAnalyzer
+
+[androidJvm]\
+object [BackgroundThreadHeapAnalyzer](index.md) : [EventListener](../-event-listener/index.md)
+
+Starts heap analysis on a background [HandlerThread](https://developer.android.com/reference/kotlin/android/os/HandlerThread.html) when receiving a [HeapDump](../-event-listener/-event/-heap-dump/index.md) event.
+
+## Functions
+
+| Name | Summary |
+|---|---|
+| [onEvent](on-event.md) | [androidJvm]<br>open override fun [onEvent](on-event.md)(event: [EventListener.Event](../-event-listener/-event/index.md))<br>[onEvent](on-event.md) is always called from the thread the events are emitted from, which is documented for each event. This enables you to potentially block a chain of events, waiting for some pre work to be done. |

docs/api/leakcanary-android-core/leakcanary/-background-thread-heap-analyzer/on-event.md

@@ -0,0 +1,8 @@
+//[leakcanary-android-core](../../../index.md)/[leakcanary](../index.md)/[BackgroundThreadHeapAnalyzer](index.md)/[onEvent](on-event.md)
+
+# onEvent
+
+[androidJvm]\
+open override fun [onEvent](on-event.md)(event: [EventListener.Event](../-event-listener/-event/index.md))
+
+[onEvent](on-event.md) is always called from the thread the events are emitted from, which is documented for each event. This enables you to potentially block a chain of events, waiting for some pre work to be done.

docs/api/leakcanary-android-core/leakcanary/-event-listener/-event/-dumping-heap/-dumping-heap.md

@@ -0,0 +1,6 @@
+//[leakcanary-android-core](../../../../../index.md)/[leakcanary](../../../index.md)/[EventListener](../../index.md)/[Event](../index.md)/[DumpingHeap](index.md)/[DumpingHeap](-dumping-heap.md)
+
+# DumpingHeap
+
+[androidJvm]\
+fun [DumpingHeap](-dumping-heap.md)(uniqueId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))

docs/api/leakcanary-android-core/leakcanary/-event-listener/-event/-dumping-heap/index.md

@@ -0,0 +1,20 @@
+//[leakcanary-android-core](../../../../../index.md)/[leakcanary](../../../index.md)/[EventListener](../../index.md)/[Event](../index.md)/[DumpingHeap](index.md)
+
+# DumpingHeap
+
+[androidJvm]\
+class [DumpingHeap](index.md)(uniqueId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [EventListener.Event](../index.md)
+
+Sent from the "LeakCanary-Heap-Dump" HandlerThread.
+
+## Constructors
+
+| | |
+|---|---|
+| [DumpingHeap](-dumping-heap.md) | [androidJvm]<br>fun [DumpingHeap](-dumping-heap.md)(uniqueId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) |
+
+## Properties
+
+| Name | Summary |
+|---|---|
+| [uniqueId](../unique-id.md) | [androidJvm]<br>val [uniqueId](../unique-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>Unique identifier for a related chain of event. The identifier for the events that run before [HeapDump](../-heap-dump/index.md) gets reset right before [HeapDump](../-heap-dump/index.md) is sent. |

docs/api/leakcanary-android-core/leakcanary/-event-listener/-event/-heap-analysis-done/-heap-analysis-failed/-heap-analysis-failed.md

@@ -0,0 +1,6 @@
+//[leakcanary-android-core](../../../../../../index.md)/[leakcanary](../../../../index.md)/[EventListener](../../../index.md)/[Event](../../index.md)/[HeapAnalysisDone](../index.md)/[HeapAnalysisFailed](index.md)/[HeapAnalysisFailed](-heap-analysis-failed.md)
+
+# HeapAnalysisFailed
+
+[androidJvm]\
+fun [HeapAnalysisFailed](-heap-analysis-failed.md)(uniqueId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), heapAnalysis: HeapAnalysisFailure, showIntent: [Intent](https://developer.android.com/reference/kotlin/android/content/Intent.html))

docs/api/leakcanary-android-core/leakcanary/-event-listener/-event/-heap-analysis-done/-heap-analysis-failed/index.md

@@ -0,0 +1,14 @@
+//[leakcanary-android-core](../../../../../../index.md)/[leakcanary](../../../../index.md)/[EventListener](../../../index.md)/[Event](../../index.md)/[HeapAnalysisDone](../index.md)/[HeapAnalysisFailed](index.md)
+
+# HeapAnalysisFailed
+
+[androidJvm]\
+class [HeapAnalysisFailed](index.md)(uniqueId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), heapAnalysis: HeapAnalysisFailure, showIntent: [Intent](https://developer.android.com/reference/kotlin/android/content/Intent.html)) : [EventListener.Event.HeapAnalysisDone](../index.md)<HeapAnalysisFailure>
+
+## Properties
+
+| Name | Summary |
+|---|---|
+| [heapAnalysis](../heap-analysis.md) | [androidJvm]<br>val [heapAnalysis](../heap-analysis.md): HeapAnalysisFailure |
+| [showIntent](../show-intent.md) | [androidJvm]<br>val [showIntent](../show-intent.md): [Intent](https://developer.android.com/reference/kotlin/android/content/Intent.html) |
+| [uniqueId](../../unique-id.md) | [androidJvm]<br>val [uniqueId](../../unique-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>Unique identifier for a related chain of event. The identifier for the events that run before [HeapDump](../../-heap-dump/index.md) gets reset right before [HeapDump](../../-heap-dump/index.md) is sent. |

docs/api/leakcanary-android-core/leakcanary/-event-listener/-event/-heap-analysis-done/-heap-analysis-succeeded/-heap-analysis-succeeded.md

@@ -0,0 +1,6 @@
+//[leakcanary-android-core](../../../../../../index.md)/[leakcanary](../../../../index.md)/[EventListener](../../../index.md)/[Event](../../index.md)/[HeapAnalysisDone](../index.md)/[HeapAnalysisSucceeded](index.md)/[HeapAnalysisSucceeded](-heap-analysis-succeeded.md)
+
+# HeapAnalysisSucceeded
+
+[androidJvm]\
+fun [HeapAnalysisSucceeded](-heap-analysis-succeeded.md)(uniqueId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), heapAnalysis: HeapAnalysisSuccess, unreadLeakSignatures: [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>, showIntent: [Intent](https://developer.android.com/reference/kotlin/android/content/Intent.html))

docs/api/leakcanary-android-core/leakcanary/-event-listener/-event/-heap-analysis-done/-heap-analysis-succeeded/index.md

@@ -0,0 +1,15 @@
+//[leakcanary-android-core](../../../../../../index.md)/[leakcanary](../../../../index.md)/[EventListener](../../../index.md)/[Event](../../index.md)/[HeapAnalysisDone](../index.md)/[HeapAnalysisSucceeded](index.md)
+
+# HeapAnalysisSucceeded
+
+[androidJvm]\
+class [HeapAnalysisSucceeded](index.md)(uniqueId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), heapAnalysis: HeapAnalysisSuccess, unreadLeakSignatures: [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>, showIntent: [Intent](https://developer.android.com/reference/kotlin/android/content/Intent.html)) : [EventListener.Event.HeapAnalysisDone](../index.md)<HeapAnalysisSuccess>
+
+## Properties
+
+| Name | Summary |
+|---|---|
+| [heapAnalysis](../heap-analysis.md) | [androidJvm]<br>val [heapAnalysis](../heap-analysis.md): HeapAnalysisSuccess |
+| [showIntent](../show-intent.md) | [androidJvm]<br>val [showIntent](../show-intent.md): [Intent](https://developer.android.com/reference/kotlin/android/content/Intent.html) |
+| [uniqueId](../../unique-id.md) | [androidJvm]<br>val [uniqueId](../../unique-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>Unique identifier for a related chain of event. The identifier for the events that run before [HeapDump](../../-heap-dump/index.md) gets reset right before [HeapDump](../../-heap-dump/index.md) is sent. |
+| [unreadLeakSignatures](unread-leak-signatures.md) | [androidJvm]<br>val [unreadLeakSignatures](unread-leak-signatures.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)&lt;[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)&gt; |

docs/api/leakcanary-android-core/leakcanary/-event-listener/-event/-heap-analysis-done/-heap-analysis-succeeded/unread-leak-signatures.md

@@ -0,0 +1,6 @@
+//[leakcanary-android-core](../../../../../../index.md)/[leakcanary](../../../../index.md)/[EventListener](../../../index.md)/[Event](../../index.md)/[HeapAnalysisDone](../index.md)/[HeapAnalysisSucceeded](index.md)/[unreadLeakSignatures](unread-leak-signatures.md)
+
+# unreadLeakSignatures
+
+[androidJvm]\
+val [unreadLeakSignatures](unread-leak-signatures.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>

docs/api/leakcanary-android-core/leakcanary/-event-listener/-event/-heap-analysis-done/heap-analysis.md

@@ -0,0 +1,6 @@
+//[leakcanary-android-core](../../../../../index.md)/[leakcanary](../../../index.md)/[EventListener](../../index.md)/[Event](../index.md)/[HeapAnalysisDone](index.md)/[heapAnalysis](heap-analysis.md)
+
+# heapAnalysis
+
+[androidJvm]\
+val [heapAnalysis](heap-analysis.md): [T](index.md)

docs/api/leakcanary-android-core/leakcanary/-event-listener/-event/-heap-analysis-done/index.md

@@ -0,0 +1,30 @@
+//[leakcanary-android-core](../../../../../index.md)/[leakcanary](../../../index.md)/[EventListener](../../index.md)/[Event](../index.md)/[HeapAnalysisDone](index.md)
+
+# HeapAnalysisDone
+
+[androidJvm]\
+sealed class [HeapAnalysisDone](index.md)<[T](index.md) : HeapAnalysis> : [EventListener.Event](../index.md)
+
+Sent from the thread performing the analysis.
+
+## Types
+
+| Name | Summary |
+|---|---|
+| [HeapAnalysisFailed](-heap-analysis-failed/index.md) | [androidJvm]<br>class [HeapAnalysisFailed](-heap-analysis-failed/index.md)(uniqueId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), heapAnalysis: HeapAnalysisFailure, showIntent: [Intent](https://developer.android.com/reference/kotlin/android/content/Intent.html)) : [EventListener.Event.HeapAnalysisDone](index.md)&lt;HeapAnalysisFailure&gt; |
+| [HeapAnalysisSucceeded](-heap-analysis-succeeded/index.md) | [androidJvm]<br>class [HeapAnalysisSucceeded](-heap-analysis-succeeded/index.md)(uniqueId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), heapAnalysis: HeapAnalysisSuccess, unreadLeakSignatures: [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)&lt;[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)&gt;, showIntent: [Intent](https://developer.android.com/reference/kotlin/android/content/Intent.html)) : [EventListener.Event.HeapAnalysisDone](index.md)&lt;HeapAnalysisSuccess&gt; |
+
+## Properties
+
+| Name | Summary |
+|---|---|
+| [heapAnalysis](heap-analysis.md) | [androidJvm]<br>val [heapAnalysis](heap-analysis.md): [T](index.md) |
+| [showIntent](show-intent.md) | [androidJvm]<br>val [showIntent](show-intent.md): [Intent](https://developer.android.com/reference/kotlin/android/content/Intent.html) |
+| [uniqueId](../unique-id.md) | [androidJvm]<br>val [uniqueId](../unique-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>Unique identifier for a related chain of event. The identifier for the events that run before [HeapDump](../-heap-dump/index.md) gets reset right before [HeapDump](../-heap-dump/index.md) is sent. |
+
+## Inheritors
+
+| Name |
+|---|
+| [HeapAnalysisSucceeded](-heap-analysis-succeeded/index.md) |
+| [HeapAnalysisFailed](-heap-analysis-failed/index.md) |

docs/api/leakcanary-android-core/leakcanary/-event-listener/-event/-heap-analysis-done/show-intent.md

@@ -0,0 +1,6 @@
+//[leakcanary-android-core](../../../../../index.md)/[leakcanary](../../../index.md)/[EventListener](../../index.md)/[Event](../index.md)/[HeapAnalysisDone](index.md)/[showIntent](show-intent.md)
+
+# showIntent
+
+[androidJvm]\
+val [showIntent](show-intent.md): [Intent](https://developer.android.com/reference/kotlin/android/content/Intent.html)

docs/api/leakcanary-android-core/leakcanary/-event-listener/-event/-heap-analysis-progress/-heap-analysis-progress.md

@@ -0,0 +1,6 @@
+//[leakcanary-android-core](../../../../../index.md)/[leakcanary](../../../index.md)/[EventListener](../../index.md)/[Event](../index.md)/[HeapAnalysisProgress](index.md)/[HeapAnalysisProgress](-heap-analysis-progress.md)
+
+# HeapAnalysisProgress
+
+[androidJvm]\
+fun [HeapAnalysisProgress](-heap-analysis-progress.md)(uniqueId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), step: OnAnalysisProgressListener.Step, progressPercent: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))

docs/api/leakcanary-android-core/leakcanary/-event-listener/-event/-heap-analysis-progress/index.md

@@ -0,0 +1,24 @@
+//[leakcanary-android-core](../../../../../index.md)/[leakcanary](../../../index.md)/[EventListener](../../index.md)/[Event](../index.md)/[HeapAnalysisProgress](index.md)
+
+# HeapAnalysisProgress
+
+[androidJvm]\
+class [HeapAnalysisProgress](index.md)(uniqueId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), step: OnAnalysisProgressListener.Step, progressPercent: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) : [EventListener.Event](../index.md)
+
+[progressPercent](progress-percent.md) is a value between 0..1
+
+Sent from the thread performing the analysis.
+
+## Constructors
+
+| | |
+|---|---|
+| [HeapAnalysisProgress](-heap-analysis-progress.md) | [androidJvm]<br>fun [HeapAnalysisProgress](-heap-analysis-progress.md)(uniqueId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), step: OnAnalysisProgressListener.Step, progressPercent: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) |
+
+## Properties
+
+| Name | Summary |
+|---|---|
+| [progressPercent](progress-percent.md) | [androidJvm]<br>val [progressPercent](progress-percent.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) |
+| [step](step.md) | [androidJvm]<br>val [step](step.md): OnAnalysisProgressListener.Step |
+| [uniqueId](../unique-id.md) | [androidJvm]<br>val [uniqueId](../unique-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>Unique identifier for a related chain of event. The identifier for the events that run before [HeapDump](../-heap-dump/index.md) gets reset right before [HeapDump](../-heap-dump/index.md) is sent. |

docs/api/leakcanary-android-core/leakcanary/-event-listener/-event/-heap-analysis-progress/progress-percent.md

@@ -0,0 +1,6 @@
+//[leakcanary-android-core](../../../../../index.md)/[leakcanary](../../../index.md)/[EventListener](../../index.md)/[Event](../index.md)/[HeapAnalysisProgress](index.md)/[progressPercent](progress-percent.md)
+
+# progressPercent
+
+[androidJvm]\
+val [progressPercent](progress-percent.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)

docs/api/leakcanary-android-core/leakcanary/-event-listener/-event/-heap-analysis-progress/step.md

@@ -0,0 +1,6 @@
+//[leakcanary-android-core](../../../../../index.md)/[leakcanary](../../../index.md)/[EventListener](../../index.md)/[Event](../index.md)/[HeapAnalysisProgress](index.md)/[step](step.md)
+
+# step
+
+[androidJvm]\
+val [step](step.md): OnAnalysisProgressListener.Step

docs/api/leakcanary-android-core/leakcanary/-event-listener/-event/-heap-dump-failed/-heap-dump-failed.md

@@ -0,0 +1,6 @@
+//[leakcanary-android-core](../../../../../index.md)/[leakcanary](../../../index.md)/[EventListener](../../index.md)/[Event](../index.md)/[HeapDumpFailed](index.md)/[HeapDumpFailed](-heap-dump-failed.md)
+
+# HeapDumpFailed
+
+[androidJvm]\
+fun [HeapDumpFailed](-heap-dump-failed.md)(uniqueId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), exception: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html), willRetryLater: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))

docs/api/leakcanary-android-core/leakcanary/-event-listener/-event/-heap-dump-failed/exception.md

@@ -0,0 +1,6 @@
+//[leakcanary-android-core](../../../../../index.md)/[leakcanary](../../../index.md)/[EventListener](../../index.md)/[Event](../index.md)/[HeapDumpFailed](index.md)/[exception](exception.md)
+
+# exception
+
+[androidJvm]\
+val [exception](exception.md): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)