Skip to content

Commit

Permalink
Prepare 2.0-beta-3 release
Browse files Browse the repository at this point in the history
  • Loading branch information
pyricau committed Aug 22, 2019
1 parent a92e813 commit 53fa190
Show file tree
Hide file tree
Showing 56 changed files with 362 additions and 55 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[shark-android](../../index.md) / [shark](../index.md) / [AndroidReferenceMatchers](index.md) / [STATIC_MTARGET_VIEW](./-s-t-a-t-i-c_-m-t-a-r-g-e-t_-v-i-e-w.md)

# STATIC_MTARGET_VIEW

`STATIC_MTARGET_VIEW`
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ Most app developers should use [appDefaults](app-defaults.md). However, you can
| [VIEW_CONFIGURATION__MCONTEXT](-v-i-e-w_-c-o-n-f-i-g-u-r-a-t-i-o-n__-m-c-o-n-t-e-x-t.md) | |
| [AUDIO_MANAGER__MCONTEXT_STATIC](-a-u-d-i-o_-m-a-n-a-g-e-r__-m-c-o-n-t-e-x-t_-s-t-a-t-i-c.md) | |
| [ACTIVITY_MANAGER_MCONTEXT](-a-c-t-i-v-i-t-y_-m-a-n-a-g-e-r_-m-c-o-n-t-e-x-t.md) | |
| [STATIC_MTARGET_VIEW](-s-t-a-t-i-c_-m-t-a-r-g-e-t_-v-i-e-w.md) | |
| [GESTURE_BOOST_MANAGER](-g-e-s-t-u-r-e_-b-o-o-s-t_-m-a-n-a-g-e-r.md) | |
| [BUBBLE_POPUP_HELPER__SHELPER](-b-u-b-b-l-e_-p-o-p-u-p_-h-e-l-p-e-r__-s-h-e-l-p-e-r.md) | |
| [LGCONTEXT__MCONTEXT](-l-g-c-o-n-t-e-x-t__-m-c-o-n-t-e-x-t.md) | |
Expand Down
2 changes: 1 addition & 1 deletion docs/api/shark-hprof/shark/-hprof-reader/-init-.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# <init>

`HprofReader(source: BufferedSource, identifierByteSize: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, startByteReadCount: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = 0L)`
`HprofReader(source: BufferedSource, identifierByteSize: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, startPosition: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = 0L)`

Reads hprof content from an Okio [BufferedSource](#).

Expand Down
9 changes: 0 additions & 9 deletions docs/api/shark-hprof/shark/-hprof-reader/byte-read-count.md

This file was deleted.

12 changes: 8 additions & 4 deletions docs/api/shark-hprof/shark/-hprof-reader/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,27 @@ is largely adapted from https://android.googlesource.com/platform/tools/base/+/s

| Name | Summary |
|---|---|
| [&lt;init&gt;](-init-.md) | `HprofReader(source: BufferedSource, identifierByteSize: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, startByteReadCount: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = 0L)`<br>Reads hprof content from an Okio [BufferedSource](#). |
| [&lt;init&gt;](-init-.md) | `HprofReader(source: BufferedSource, identifierByteSize: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, startPosition: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = 0L)`<br>Reads hprof content from an Okio [BufferedSource](#). |

### Properties

| Name | Summary |
|---|---|
| [byteReadCount](byte-read-count.md) | `var byteReadCount: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)<br>Starts at [startByteReadCount](start-byte-read-count.md) and increases as [HprofReader](./index.md) reads bytes. This is useful for tracking the position of content in the backing [source](#). This never resets. |
| [identifierByteSize](identifier-byte-size.md) | `val identifierByteSize: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>Size of Hprof identifiers. Identifiers are used to represent UTF8 strings, objects, stack traces, etc. They can have the same size as host pointers or sizeof(void*), but are not required to be. |
| [startByteReadCount](start-byte-read-count.md) | `val startByteReadCount: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)<br>How many bytes have already been read from [source](#) when this [HprofReader](./index.md) is created. |
| [position](position.md) | `var position: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)<br>Starts at [startPosition](start-position.md) and increases as [HprofReader](./index.md) reads bytes. This is useful for tracking the position of content in the backing [source](#). This never resets. |
| [startPosition](start-position.md) | `val startPosition: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)<br>How many bytes have already been read from [source](#) when this [HprofReader](./index.md) is created. |

### Functions

| Name | Summary |
|---|---|
| [readClassDumpRecord](read-class-dump-record.md) | `fun readClassDumpRecord(): `[`HprofRecord.HeapDumpRecord.ObjectRecord.ClassDumpRecord`](../-hprof-record/-heap-dump-record/-object-record/-class-dump-record/index.md)<br>Reads a full class record after a class dump tag. |
| [readHprofRecords](read-hprof-records.md) | `fun readHprofRecords(recordTypes: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`KClass`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html)`<out `[`HprofRecord`](../-hprof-record/index.md)`>>, listener: `[`OnHprofRecordListener`](../-on-hprof-record-listener/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)<br>Reads all hprof records from [source](#). Assumes the [reader](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io/java.io.-file/reader.html) was just created, with a source that currently points to the start position of hprof records. |
| [readClassSkipContentRecord](read-class-skip-content-record.md) | `fun readClassSkipContentRecord(): `[`HprofRecord.HeapDumpRecord.ObjectRecord.ClassSkipContentRecord`](../-hprof-record/-heap-dump-record/-object-record/-class-skip-content-record/index.md)<br>Reads a class record after a class dump tag, skipping its content. |
| [readHprofRecords](read-hprof-records.md) | `fun readHprofRecords(recordTypes: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`KClass`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html)`<out `[`HprofRecord`](../-hprof-record/index.md)`>>, listener: `[`OnHprofRecordListener`](../-on-hprof-record-listener/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)<br>Reads all hprof records from [source](#). Assumes the [reader](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io/java.io.-file/reader.html) was has a source that currently points to the start position of hprof records. |
| [readInstanceDumpRecord](read-instance-dump-record.md) | `fun readInstanceDumpRecord(): `[`HprofRecord.HeapDumpRecord.ObjectRecord.InstanceDumpRecord`](../-hprof-record/-heap-dump-record/-object-record/-instance-dump-record/index.md)<br>Reads a full instance record after a instance dump tag. |
| [readInstanceSkipContentRecord](read-instance-skip-content-record.md) | `fun readInstanceSkipContentRecord(): `[`HprofRecord.HeapDumpRecord.ObjectRecord.InstanceSkipContentRecord`](../-hprof-record/-heap-dump-record/-object-record/-instance-skip-content-record/index.md)<br>Reads an instance record after a instance dump tag, skipping its content. |
| [readObjectArrayDumpRecord](read-object-array-dump-record.md) | `fun readObjectArrayDumpRecord(): `[`HprofRecord.HeapDumpRecord.ObjectRecord.ObjectArrayDumpRecord`](../-hprof-record/-heap-dump-record/-object-record/-object-array-dump-record/index.md)<br>Reads a full object array record after a object array dump tag. |
| [readObjectArraySkipContentRecord](read-object-array-skip-content-record.md) | `fun readObjectArraySkipContentRecord(): `[`HprofRecord.HeapDumpRecord.ObjectRecord.ObjectArraySkipContentRecord`](../-hprof-record/-heap-dump-record/-object-record/-object-array-skip-content-record/index.md)<br>Reads an object array record after a object array dump tag, skipping its content. |
| [readPrimitiveArrayDumpRecord](read-primitive-array-dump-record.md) | `fun readPrimitiveArrayDumpRecord(): `[`HprofRecord.HeapDumpRecord.ObjectRecord.PrimitiveArrayDumpRecord`](../-hprof-record/-heap-dump-record/-object-record/-primitive-array-dump-record/index.md)<br>Reads a full primitive array record after a primitive array dump tag. |
| [readPrimitiveArraySkipContentRecord](read-primitive-array-skip-content-record.md) | `fun readPrimitiveArraySkipContentRecord(): `[`HprofRecord.HeapDumpRecord.ObjectRecord.PrimitiveArraySkipContentRecord`](../-hprof-record/-heap-dump-record/-object-record/-primitive-array-skip-content-record/index.md)<br>Reads a primitive array record after a primitive array dump tag, skipping its content. |
| [readValue](read-value.md) | `fun readValue(type: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`ValueHolder`](../-value-holder/index.md)<br>Reads a value in the heap dump, which can be a reference or a primitive type. |
9 changes: 9 additions & 0 deletions docs/api/shark-hprof/shark/-hprof-reader/position.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[shark-hprof](../../index.md) / [shark](../index.md) / [HprofReader](index.md) / [position](./position.md)

# position

`var position: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)

Starts at [startPosition](start-position.md) and increases as [HprofReader](index.md) reads bytes. This is useful
for tracking the position of content in the backing [source](#). This never resets.

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[shark-hprof](../../index.md) / [shark](../index.md) / [HprofReader](index.md) / [readClassSkipContentRecord](./read-class-skip-content-record.md)

# readClassSkipContentRecord

`fun readClassSkipContentRecord(): `[`HprofRecord.HeapDumpRecord.ObjectRecord.ClassSkipContentRecord`](../-hprof-record/-heap-dump-record/-object-record/-class-skip-content-record/index.md)

Reads a class record after a class dump tag, skipping its content.

Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
`fun readHprofRecords(recordTypes: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`KClass`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html)`<out `[`HprofRecord`](../-hprof-record/index.md)`>>, listener: `[`OnHprofRecordListener`](../-on-hprof-record-listener/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)

Reads all hprof records from [source](#).
Assumes the [reader](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io/java.io.-file/reader.html) was just created, with a source that currently points to the start
position of hprof records.
Assumes the [reader](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io/java.io.-file/reader.html) was has a source that currently points to the start position of hprof
records.

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[shark-hprof](../../index.md) / [shark](../index.md) / [HprofReader](index.md) / [readInstanceSkipContentRecord](./read-instance-skip-content-record.md)

# readInstanceSkipContentRecord

`fun readInstanceSkipContentRecord(): `[`HprofRecord.HeapDumpRecord.ObjectRecord.InstanceSkipContentRecord`](../-hprof-record/-heap-dump-record/-object-record/-instance-skip-content-record/index.md)

Reads an instance record after a instance dump tag, skipping its content.

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[shark-hprof](../../index.md) / [shark](../index.md) / [HprofReader](index.md) / [readObjectArraySkipContentRecord](./read-object-array-skip-content-record.md)

# readObjectArraySkipContentRecord

`fun readObjectArraySkipContentRecord(): `[`HprofRecord.HeapDumpRecord.ObjectRecord.ObjectArraySkipContentRecord`](../-hprof-record/-heap-dump-record/-object-record/-object-array-skip-content-record/index.md)

Reads an object array record after a object array dump tag, skipping its content.

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[shark-hprof](../../index.md) / [shark](../index.md) / [HprofReader](index.md) / [readPrimitiveArraySkipContentRecord](./read-primitive-array-skip-content-record.md)

# readPrimitiveArraySkipContentRecord

`fun readPrimitiveArraySkipContentRecord(): `[`HprofRecord.HeapDumpRecord.ObjectRecord.PrimitiveArraySkipContentRecord`](../-hprof-record/-heap-dump-record/-object-record/-primitive-array-skip-content-record/index.md)

Reads a primitive array record after a primitive array dump tag, skipping its content.

This file was deleted.

8 changes: 8 additions & 0 deletions docs/api/shark-hprof/shark/-hprof-reader/start-position.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[shark-hprof](../../index.md) / [shark](../index.md) / [HprofReader](index.md) / [startPosition](./start-position.md)

# startPosition

`val startPosition: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)

How many bytes have already been read from [source](#) when this [HprofReader](index.md) is created.

Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[shark-hprof](../../../../../index.md) / [shark](../../../../index.md) / [HprofRecord](../../../index.md) / [HeapDumpRecord](../../index.md) / [ObjectRecord](../index.md) / [ClassSkipContentRecord](index.md) / [&lt;init&gt;](./-init-.md)

# &lt;init&gt;

`ClassSkipContentRecord(id: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, stackTraceSerialNumber: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, superclassId: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, classLoaderId: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, signersId: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, protectionDomainId: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, instanceSize: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, staticFieldCount: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, fieldCount: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)`

This isn't a real record type as found in the heap dump. It's an alternative to
[ClassDumpRecord](../-class-dump-record/index.md) for when you don't need the class content.

Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[shark-hprof](../../../../../index.md) / [shark](../../../../index.md) / [HprofRecord](../../../index.md) / [HeapDumpRecord](../../index.md) / [ObjectRecord](../index.md) / [ClassSkipContentRecord](index.md) / [classLoaderId](./class-loader-id.md)

# classLoaderId

`val classLoaderId: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[shark-hprof](../../../../../index.md) / [shark](../../../../index.md) / [HprofRecord](../../../index.md) / [HeapDumpRecord](../../index.md) / [ObjectRecord](../index.md) / [ClassSkipContentRecord](index.md) / [fieldCount](./field-count.md)

# fieldCount

`val fieldCount: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[shark-hprof](../../../../../index.md) / [shark](../../../../index.md) / [HprofRecord](../../../index.md) / [HeapDumpRecord](../../index.md) / [ObjectRecord](../index.md) / [ClassSkipContentRecord](index.md) / [id](./id.md)

# id

`val id: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
[shark-hprof](../../../../../index.md) / [shark](../../../../index.md) / [HprofRecord](../../../index.md) / [HeapDumpRecord](../../index.md) / [ObjectRecord](../index.md) / [ClassSkipContentRecord](./index.md)

# ClassSkipContentRecord

`class ClassSkipContentRecord : `[`HprofRecord.HeapDumpRecord.ObjectRecord`](../index.md)

This isn't a real record type as found in the heap dump. It's an alternative to
[ClassDumpRecord](../-class-dump-record/index.md) for when you don't need the class content.

### Constructors

| Name | Summary |
|---|---|
| [&lt;init&gt;](-init-.md) | `ClassSkipContentRecord(id: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, stackTraceSerialNumber: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, superclassId: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, classLoaderId: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, signersId: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, protectionDomainId: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, instanceSize: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, staticFieldCount: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, fieldCount: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)`<br>This isn't a real record type as found in the heap dump. It's an alternative to [ClassDumpRecord](../-class-dump-record/index.md) for when you don't need the class content. |

### Properties

| Name | Summary |
|---|---|
| [classLoaderId](class-loader-id.md) | `val classLoaderId: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) |
| [fieldCount](field-count.md) | `val fieldCount: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) |
| [id](id.md) | `val id: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) |
| [instanceSize](instance-size.md) | `val instanceSize: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) |
| [protectionDomainId](protection-domain-id.md) | `val protectionDomainId: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) |
| [signersId](signers-id.md) | `val signersId: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) |
| [stackTraceSerialNumber](stack-trace-serial-number.md) | `val stackTraceSerialNumber: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) |
| [staticFieldCount](static-field-count.md) | `val staticFieldCount: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) |
| [superclassId](superclass-id.md) | `val superclassId: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) |
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[shark-hprof](../../../../../index.md) / [shark](../../../../index.md) / [HprofRecord](../../../index.md) / [HeapDumpRecord](../../index.md) / [ObjectRecord](../index.md) / [ClassSkipContentRecord](index.md) / [instanceSize](./instance-size.md)

# instanceSize

`val instanceSize: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[shark-hprof](../../../../../index.md) / [shark](../../../../index.md) / [HprofRecord](../../../index.md) / [HeapDumpRecord](../../index.md) / [ObjectRecord](../index.md) / [ClassSkipContentRecord](index.md) / [protectionDomainId](./protection-domain-id.md)

# protectionDomainId

`val protectionDomainId: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[shark-hprof](../../../../../index.md) / [shark](../../../../index.md) / [HprofRecord](../../../index.md) / [HeapDumpRecord](../../index.md) / [ObjectRecord](../index.md) / [ClassSkipContentRecord](index.md) / [signersId](./signers-id.md)

# signersId

`val signersId: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[shark-hprof](../../../../../index.md) / [shark](../../../../index.md) / [HprofRecord](../../../index.md) / [HeapDumpRecord](../../index.md) / [ObjectRecord](../index.md) / [ClassSkipContentRecord](index.md) / [stackTraceSerialNumber](./stack-trace-serial-number.md)

# stackTraceSerialNumber

`val stackTraceSerialNumber: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)

0 comments on commit 53fa190

Please sign in to comment.