Skip to content

Commit

Permalink
Generated updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chRyNaN committed Feb 13, 2022
1 parent 1eb4620 commit 28d5855
Show file tree
Hide file tree
Showing 154 changed files with 1,469 additions and 987 deletions.
6 changes: 3 additions & 3 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ allprojects {
}
}

rootProject.plugins.withType < org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsRootPlugin > {
rootProject.the < org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsRootExtension > ().nodeVersion = "16.0.0"
rootProject.plugins.withType<org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsRootPlugin> {
rootProject.the<org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsRootExtension>().nodeVersion = "16.0.0"
}

// Documentation
tasks.named < org.jetbrains.dokka.gradle.DokkaMultiModuleTask > ("dokkaGfmMultiModule").configure {
tasks.named<org.jetbrains.dokka.gradle.DokkaMultiModuleTask>("dokkaGfmMultiModule").configure {
outputDirectory.set(file("${projectDir.path}/docs"))
}
10 changes: 3 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
/

## All modules:


## All modules:

| Name |
| Name |
|---|
| <a name=".ext/parcelable-core///PointingToDeclaration/"></a>[parcelable-core](parcelable-core/index.md)| <a name=".ext/parcelable-core///PointingToDeclaration/"></a>
| <a name=".ext/parcelable-android///PointingToDeclaration/"></a>[parcelable-android](parcelable-android/index.md)| <a name=".ext/parcelable-android///PointingToDeclaration/"></a>

| [parcelable-core](parcelable-core/index.md) | |
187 changes: 187 additions & 0 deletions docs/package-list

Large diffs are not rendered by default.

12 changes: 4 additions & 8 deletions docs/parcelable-core/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
//[parcelable-core](index.md)

# parcelable-core

## Packages

# parcelable-core


## Packages

| Name |
| Name |
|---|
| <a name="com.chrynan.parcelable.core////PointingToDeclaration/"></a>[com.chrynan.parcelable.core](parcelable-core/com.chrynan.parcelable.core/index.md)|

| [com.chrynan.parcelable.core](parcelable-core/com.chrynan.parcelable.core/index.md) |
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[AndroidParcel](-android-parcel.md)

# AndroidParcel

[android]\
fun [AndroidParcel](-android-parcel.md)(parcel: [Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html))
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[dataBufferCapacity](data-buffer-capacity.md)

# dataBufferCapacity

[android]\
open override val [dataBufferCapacity](data-buffer-capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)

The total amount of space available in this parcel. This should always be greater than or equal to [dataSize](data-size.md). There may be more space available ([dataBufferCapacity](data-buffer-capacity.md)) in the underlying data buffer than there is data available ([dataSize](data-size.md)). The difference between [dataBufferCapacity](data-buffer-capacity.md) and [dataSize](data-size.md) indicates the amount of room remaining in the underlying data buffer until more space needs to be allocated.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[dataPosition](data-position.md)

# dataPosition

[android]\
open override val [dataPosition](data-position.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)

The current index position in the data buffer. Should never be more than [dataSize](data-size.md).
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[dataSize](data-size.md)

# dataSize

[android]\
open override val [dataSize](data-size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)

The total amount of data contained in this parcel.
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)

# AndroidParcel

[android]\
class [AndroidParcel](index.md)(parcel: [Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html)) : [Parcel](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/index.md)

An Android implementation of the [Parcel](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/index.md) interface. This class wraps the provided [android.os.Parcel](../../../../parcelable-core/com.chrynan.parcelable.core/-android-parcel/parcel.md) and delegates the reading and writing to it.

Note that this class should not be confused with the [android.os.Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html). Instead, this class wraps that class and implements the [Parcel](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/index.md) interface of this library.

## See also

android

| | |
|---|---|
| [com.chrynan.parcelable.core.Parcel](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/index.md) | |
| [android.os.Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html) | |

## Constructors

| | |
|---|---|
| [AndroidParcel](-android-parcel.md) | [android]<br>fun [AndroidParcel](-android-parcel.md)(parcel: [Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html)) |

## Functions

| Name | Summary |
|---|---|
| [readBoolean](read-boolean.md) | [android]<br>open override fun [readBoolean](read-boolean.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)<br>Retrieves a [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) from the Parcel at the current data position. |
| [readByte](read-byte.md) | [android]<br>open override fun [readByte](read-byte.md)(): [Byte](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html)<br>Retrieves a [Byte](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html) from the Parcel at the current data position. |
| [readChar](read-char.md) | [android]<br>open override fun [readChar](read-char.md)(): [Char](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html)<br>Retrieves a [Char](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html) from the Parcel at the current data position. |
| [readDouble](read-double.md) | [android]<br>open override fun [readDouble](read-double.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)<br>Retrieves a [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) from the Parcel at the current data position. |
| [readFloat](read-float.md) | [android]<br>open override fun [readFloat](read-float.md)(): [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)<br>Retrieves a [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html) from the Parcel at the current data position. |
| [readInt](read-int.md) | [android]<br>open override fun [readInt](read-int.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>Retrieves a [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) from the Parcel at the current data position. |
| [readLong](read-long.md) | [android]<br>open override fun [readLong](read-long.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)<br>Retrieves a [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) from the Parcel at the current data position. |
| [readShort](read-short.md) | [android]<br>open override fun [readShort](read-short.md)(): [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html)<br>Retrieves a [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) from the Parcel at the current data position. |
| [readString](read-string.md) | [android]<br>open override fun [readString](read-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>Retrieves a [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) from the Parcel at the current data position. |
| [recycle](recycle.md) | [android]<br>open override fun [recycle](recycle.md)()<br>Puts this parcel object back into the pool, removing its data. This parcel object should not be used after it is recycled. |
| [toByteArray](to-byte-array.md) | [android]<br>open override fun [toByteArray](to-byte-array.md)(): [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)<br>Obtains a [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) of the underlying values of this [Parcel](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/index.md). |
| [writeBoolean](write-boolean.md) | [android]<br>open override fun [writeBoolean](write-boolean.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))<br>Writes the [Boolean](write-boolean.md) to the Parcel at the current data position. |
| [writeByte](write-byte.md) | [android]<br>open override fun [writeByte](write-byte.md)(value: [Byte](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html))<br>Writes the [Byte](write-byte.md) to the Parcel at the current data position. |
| [writeChar](write-char.md) | [android]<br>open override fun [writeChar](write-char.md)(value: [Char](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html))<br>Writes the [Char](write-char.md) to the Parcel at the current data position. |
| [writeDouble](write-double.md) | [android]<br>open override fun [writeDouble](write-double.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))<br>Writes the [Double](write-double.md) to the Parcel at the current data position. |
| [writeFloat](write-float.md) | [android]<br>open override fun [writeFloat](write-float.md)(value: [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html))<br>Writes the [Float](write-float.md) to the Parcel at the current data position. |
| [writeInt](write-int.md) | [android]<br>open override fun [writeInt](write-int.md)(value: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))<br>Writes the [Int](write-int.md) to the Parcel at the current data position. |
| [writeLong](write-long.md) | [android]<br>open override fun [writeLong](write-long.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))<br>Writes the [Long](write-long.md) to the Parcel at the current data position. |
| [writeShort](write-short.md) | [android]<br>open override fun [writeShort](write-short.md)(value: [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html))<br>Writes the [Short](write-short.md) to the Parcel at the current data position. |
| [writeString](write-string.md) | [android]<br>open override fun [writeString](write-string.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))<br>Writes the [String](write-string.md) to the Parcel at the current data position. |

## Properties

| Name | Summary |
|---|---|
| [dataBufferCapacity](data-buffer-capacity.md) | [android]<br>open override val [dataBufferCapacity](data-buffer-capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>The total amount of space available in this parcel. This should always be greater than or equal to [dataSize](data-size.md). There may be more space available ([dataBufferCapacity](data-buffer-capacity.md)) in the underlying data buffer than there is data available ([dataSize](data-size.md)). The difference between [dataBufferCapacity](data-buffer-capacity.md) and [dataSize](data-size.md) indicates the amount of room remaining in the underlying data buffer until more space needs to be allocated. |
| [dataPosition](data-position.md) | [android]<br>open override val [dataPosition](data-position.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>The current index position in the data buffer. Should never be more than [dataSize](data-size.md). |
| [dataRemaining](index.md#-139993914%2FProperties%2F-1462739831) | [android]<br>open val [dataRemaining](index.md#-139993914%2FProperties%2F-1462739831): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>The remaining amount of data to be read ([dataSize](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/data-size.md) - [dataPosition](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/data-position.md)). |
| [dataSize](data-size.md) | [android]<br>open override val [dataSize](data-size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>The total amount of data contained in this parcel. |
| [isRecycled](is-recycled.md) | [android]<br>open override var [isRecycled](is-recycled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false<br>Determines whether this [Parcel](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/index.md)s [recycle](recycle.md) function has been called already. A parcel object should not be used after it is recycled. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[isRecycled](is-recycled.md)

# isRecycled

[android]\
open override var [isRecycled](is-recycled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false

Determines whether this [Parcel](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/index.md)s [recycle](recycle.md) function has been called already. A parcel object should not be used after it is recycled.

Note that this property is unstable between processes.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[readBoolean](read-boolean.md)

# readBoolean

[android]\
open override fun [readBoolean](read-boolean.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)

Retrieves a [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) from the Parcel at the current data position.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[readByte](read-byte.md)

# readByte

[android]\
open override fun [readByte](read-byte.md)(): [Byte](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html)

Retrieves a [Byte](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html) from the Parcel at the current data position.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[readChar](read-char.md)

# readChar

[android]\
open override fun [readChar](read-char.md)(): [Char](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html)

Retrieves a [Char](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html) from the Parcel at the current data position.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[readDouble](read-double.md)

# readDouble

[android]\
open override fun [readDouble](read-double.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)

Retrieves a [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) from the Parcel at the current data position.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[readFloat](read-float.md)

# readFloat

[android]\
open override fun [readFloat](read-float.md)(): [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)

Retrieves a [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html) from the Parcel at the current data position.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[readInt](read-int.md)

# readInt

[android]\
open override fun [readInt](read-int.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)

Retrieves a [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) from the Parcel at the current data position.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[readLong](read-long.md)

# readLong

[android]\
open override fun [readLong](read-long.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)

Retrieves a [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) from the Parcel at the current data position.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[readShort](read-short.md)

# readShort

[android]\
open override fun [readShort](read-short.md)(): [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html)

Retrieves a [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) from the Parcel at the current data position.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[readString](read-string.md)

# readString

[android]\
open override fun [readString](read-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)

Retrieves a [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) from the Parcel at the current data position.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[recycle](recycle.md)

# recycle

[android]\
open override fun [recycle](recycle.md)()

Puts this parcel object back into the pool, removing its data. This parcel object should not be used after it is recycled.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[toByteArray](to-byte-array.md)

# toByteArray

[android]\
open override fun [toByteArray](to-byte-array.md)(): [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)

Obtains a [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) of the underlying values of this [Parcel](../../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcel/index.md).
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[writeBoolean](write-boolean.md)

# writeBoolean

[android]\
open override fun [writeBoolean](write-boolean.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))

Writes the [Boolean](write-boolean.md) to the Parcel at the current data position.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[writeByte](write-byte.md)

# writeByte

[android]\
open override fun [writeByte](write-byte.md)(value: [Byte](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html))

Writes the [Byte](write-byte.md) to the Parcel at the current data position.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[writeChar](write-char.md)

# writeChar

[android]\
open override fun [writeChar](write-char.md)(value: [Char](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html))

Writes the [Char](write-char.md) to the Parcel at the current data position.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[parcelable-core](../../../index.md)/[com.chrynan.parcelable.core](../index.md)/[AndroidParcel](index.md)/[writeDouble](write-double.md)

# writeDouble

[android]\
open override fun [writeDouble](write-double.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))

Writes the [Double](write-double.md) to the Parcel at the current data position.
Loading

0 comments on commit 28d5855

Please sign in to comment.