Generated updated documentation

Author: Chris

docs/krypt-core/krypt-core/com.chrynan.krypt.core/-endian/index.md

@@ -9,7 +9,7 @@ Represents the order of a "word" or a numeric value that consists of m
 
 Note that technically, the endianness is abstracted away from Kotlin, and each target platform may represent the values using their desired endian order. However, sometimes when working with [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)s, it is required to convert them to numeric values, such as [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) or [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), so, in those scenarios, it is required to specify the order of how the [Byte](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html)s are converted to the numerical value. Though this conversion is different from how the value is internally stored or represented, it will result in different numeric values depending on the order.
 
-## See also
+#### See also
 
 common
 
@@ -24,6 +24,13 @@ common
 | [Big](-big/index.md) | [common]<br>[Big](-big/index.md) |
 | [Little](-little/index.md) | [common]<br>[Little](-little/index.md) |
 
+## Functions
+
+| Name | Summary |
+|---|---|
+| [valueOf](value-of.md) | [common]<br>fun [valueOf](value-of.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Endian](index.md)<br>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) |
+| [values](values.md) | [common]<br>fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)&lt;[Endian](index.md)&gt;<br>Returns an array containing the constants of this enum type, in the order they're declared. |
+
 ## Properties
 
 | Name | Summary |

docs/krypt-core/krypt-core/com.chrynan.krypt.core/-endian/value-of.md

@@ -0,0 +1,14 @@
+//[krypt-core](../../../index.md)/[com.chrynan.krypt.core](../index.md)/[Endian](index.md)/[valueOf](value-of.md)
+
+# valueOf
+
+[common]\
+fun [valueOf](value-of.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Endian](index.md)
+
+Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
+
+#### Throws
+
+| | |
+|---|---|
+| [IllegalArgumentException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html) | if this enum type has no constant with the specified name |

docs/krypt-core/krypt-core/com.chrynan.krypt.core/-endian/values.md

@@ -0,0 +1,10 @@
+//[krypt-core](../../../index.md)/[com.chrynan.krypt.core](../index.md)/[Endian](index.md)/[values](values.md)
+
+# values
+
+[common]\
+fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Endian](index.md)>
+
+Returns an array containing the constants of this enum type, in the order they're declared.
+
+This method may be used to iterate over the constants.

docs/krypt-core/krypt-core/com.chrynan.krypt.core/-hash-function.md

@@ -0,0 +1,8 @@
+//[krypt-core](../../index.md)/[com.chrynan.krypt.core](index.md)/[HashFunction](-hash-function.md)
+
+# HashFunction
+
+[common]\
+fun <[Input](-hash-function.md), [Output](-hash-function.md)> [HashFunction](-hash-function.md)(algorithmName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, hash: suspend (source: [Input](-hash-function.md)) -> [Output](-hash-function.md)): [HashFunction](-hash-function/index.md)<[Input](-hash-function.md), [Output](-hash-function.md)>
+
+Creates a [HashFunction](-hash-function/index.md) implementation using the provided [algorithmName](-hash-function.md) and [hash](-hash-function.md) function block.

docs/krypt-core/krypt-core/com.chrynan.krypt.core/-hash-function/index.md

@@ -7,7 +7,7 @@ interface [HashFunction](index.md)<[Input](index.md), [Output](index.md)>
 
 Represents a cryptographic hash function, or a secure one-way hash function that takes arbitrarily sized input data of type [Input](index.md) and outputs a value of type [Output](index.md), which contains or is a fixed size hash value ("message-digest") as a result of this function. The result of performing a hash function cannot be reversed, meaning that the input value cannot be obtained by reversing the hash, as a hash function is a one-way function. Different implementations of this interface may represent different hashing algorithms, such as "SHA256" or "Argon2ID". It is common to use a hash function with a password in an authentication flow for a system.
 
-## See also
+#### See also
 
 common
 

docs/krypt-core/krypt-core/com.chrynan.krypt.core/-key-pair/index.md

@@ -9,7 +9,7 @@ Represents a grouping of a [publicKey](public-key.md) and [privateKey](private-k
 
 Note that this interface was inspired by the [java.security.KeyPair interface](https://docs.oracle.com/javase/8/docs/api/java/security/KeyPair.html).
 
-## See also
+#### See also
 
 common
 

docs/krypt-core/krypt-core/com.chrynan.krypt.core/-key/index.md

@@ -9,7 +9,7 @@ Represents a cryptographic key used in cryptographic algorithms, such as hashing
 
 Note that this interface was inspired by the [java.security.Key interface](https://docs.oracle.com/javase/8/docs/api/java/security/Key.html).
 
-## See also
+#### See also
 
 common
 

docs/krypt-core/krypt-core/com.chrynan.krypt.core/-secret-key/index.md

@@ -9,7 +9,7 @@ Represents a secret key for a symmetric encryption algorithm.
 
 Note that this interface was inspired by the [javax.crypto.SecretKey interface](https://docs.oracle.com/javase/8/docs/api/javax/crypto/SecretKey.html).
 
-## See also
+#### See also
 
 common
 

docs/krypt-core/krypt-core/com.chrynan.krypt.core/-secure-string/index.md

@@ -45,3 +45,4 @@ This implementation was inspired by the following: https://github.com/Password4j
 | Name | Summary |
 |---|---|
 | [plus](../plus.md) | [common]<br>operator fun [SecureString](index.md).[plus](../plus.md)(other: [CharSequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html)): [SecureString](index.md) |
+| [toSecureString](../to-secure-string.md) | [common]<br>fun [CharSequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html).[toSecureString](../to-secure-string.md)(): [SecureString](index.md) |

docs/krypt-core/krypt-core/com.chrynan.krypt.core/[android]to-multiplatform-key-pair.md

@@ -0,0 +1,8 @@
+//[krypt-core](../../index.md)/[com.chrynan.krypt.core](index.md)/[[android]toMultiplatformKeyPair]([android]to-multiplatform-key-pair.md)
+
+# toMultiplatformKeyPair
+
+[android]\
+fun [KeyPair](https://developer.android.com/reference/kotlin/java/security/KeyPair.html).[toMultiplatformKeyPair]([android]to-multiplatform-key-pair.md)(): [KeyPair](../../../krypt-core/krypt-core/com.chrynan.krypt.core/-key-pair/index.md)<[Key](../../../krypt-core/krypt-core/com.chrynan.krypt.core/-key/index.md), [Key](../../../krypt-core/krypt-core/com.chrynan.krypt.core/-key/index.md)>
+
+Converts this [java.security.KeyPair](https://developer.android.com/reference/kotlin/java/security/KeyPair.html) to a [KeyPair](../../../krypt-core/krypt-core/com.chrynan.krypt.core/-key-pair/index.md) instance from this krypt library.

docs/krypt-core/krypt-core/com.chrynan.krypt.core/[jvm]to-multiplatform-key-pair.md

@@ -0,0 +1,8 @@
+//[krypt-core](../../index.md)/[com.chrynan.krypt.core](index.md)/[[jvm]toMultiplatformKeyPair]([jvm]to-multiplatform-key-pair.md)
+
+# toMultiplatformKeyPair
+
+[jvm]\
+fun [KeyPair](https://developer.android.com/reference/kotlin/java/security/KeyPair.html).[toMultiplatformKeyPair]([jvm]to-multiplatform-key-pair.md)(): [KeyPair](../../../krypt-core/krypt-core/com.chrynan.krypt.core/-key-pair/index.md)<[Key](../../../krypt-core/krypt-core/com.chrynan.krypt.core/-key/index.md), [Key](../../../krypt-core/krypt-core/com.chrynan.krypt.core/-key/index.md)>
+
+Converts this [java.security.KeyPair](https://developer.android.com/reference/kotlin/java/security/KeyPair.html) to a [KeyPair](../../../krypt-core/krypt-core/com.chrynan.krypt.core/-key-pair/index.md) instance from this krypt library.

docs/krypt-core/krypt-core/com.chrynan.krypt.core/index.md

@@ -1,6 +1,6 @@
 //[krypt-core](../../index.md)/[com.chrynan.krypt.core](index.md)
 
-# Package com.chrynan.krypt.core
+# Package-level declarations
 
 ## Types
 
@@ -24,11 +24,13 @@
 |---|---|
 | [generate](generate.md) | [common]<br>suspend fun &lt;[K](generate.md) : [Key](-key/index.md)&gt; [KeyGenerator](-key-generator/index.md)&lt;[K](generate.md)&gt;.[generate](generate.md)(): [K](generate.md)<br>A convenience function that calls the [KeyGenerator.invoke](-key-generator/invoke.md) function. Which function is used is up to preference.<br>[common]<br>suspend fun &lt;[PublicKey](generate.md), [PrivateKey](generate.md)&gt; [KeyPairGenerator](-key-pair-generator/index.md)&lt;[PublicKey](generate.md), [PrivateKey](generate.md)&gt;.[generate](generate.md)(): [KeyPair](-key-pair/index.md)&lt;[PublicKey](generate.md), [PrivateKey](generate.md)&gt;<br>A convenience function that calls the [invoke](invoke.md) function. Which function is used is up to preference. |
 | [hash](hash.md) | [common]<br>suspend fun &lt;[Input](hash.md), [Output](hash.md)&gt; [HashFunction](-hash-function/index.md)&lt;[Input](hash.md), [Output](hash.md)&gt;.[hash](hash.md)(source: [Input](hash.md)): [Output](hash.md)<br>A convenience function that delegates to the [invoke](invoke.md) function of the [HashFunction](-hash-function/index.md) interface. This is provided for preference, as it may be preferable to use &quot;hash&quot; instead of &quot;invoke&quot; at the call-site. |
+| [HashFunction](-hash-function.md) | [common]<br>fun &lt;[Input](-hash-function.md), [Output](-hash-function.md)&gt; [HashFunction](-hash-function.md)(algorithmName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, hash: suspend (source: [Input](-hash-function.md)) -&gt; [Output](-hash-function.md)): [HashFunction](-hash-function/index.md)&lt;[Input](-hash-function.md), [Output](-hash-function.md)&gt;<br>Creates a [HashFunction](-hash-function/index.md) implementation using the provided [algorithmName](-hash-function.md) and [hash](-hash-function.md) function block. |
 | [invoke](invoke.md) | [common]<br>operator fun [SecureString.Companion](-secure-string/-companion/index.md).[invoke](invoke.md)(charSequence: [CharSequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html)): [SecureString](-secure-string/index.md)<br>[common]<br>suspend operator fun [HMAC.Companion](-h-m-a-c/-companion/index.md).[invoke](invoke.md)(key: [Key](-key/index.md), message: [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html), hash: [HashFunction](-hash-function/index.md)&lt;[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html), [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)&gt;, blockSize: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)<br>A convenience function for invoking the [invoke](invoke.md) function with the provided [key](-key/index.md) value.<br>[common]<br>suspend operator fun [HMAC.Companion](-h-m-a-c/-companion/index.md).[invoke](invoke.md)(key: [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html), message: [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html), hash: [HashFunction](-hash-function/index.md)&lt;[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html), [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)&gt;, blockSize: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)<br>A function that can generate a HMAC (Hash-based message authentication code). A message authentication code (MAC) is a value used to verify the data integrity and authenticity of a message (or data). A HMAC is a way of computing a MAC for data using a cryptographic hash function. The returned value is a MAC that can be included with a message to verify its authenticity and to ensure that the message data has not been tampered with. |
 | [isNodeJs](is-node-js.md) | [js]<br>fun [isNodeJs](is-node-js.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) |
 | [plus](plus.md) | [common]<br>operator fun [SecureString](-secure-string/index.md).[plus](plus.md)(other: [CharSequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html)): [SecureString](-secure-string/index.md) |
 | [toByteArray](to-byte-array.md) | [common]<br>fun [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html).[toByteArray](to-byte-array.md)(order: [Endian](-endian/index.md) = Endian.Big): [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)<br>Converts this [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) value into a [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) representation in the provided [order](to-byte-array.md).<br>[common]<br>fun [IntArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html).[toByteArray](to-byte-array.md)(order: [Endian](-endian/index.md) = Endian.Big): [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)<br>Converts this [IntArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html) into a [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) by converting each [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) in this array into a [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) with the provided [order](to-byte-array.md) and appending the results.<br>[common]<br>fun [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html).[toByteArray](to-byte-array.md)(order: [Endian](-endian/index.md) = Endian.Big): [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)<br>Converts this [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) value into a [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) representation in the provided [order](to-byte-array.md).<br>[common]<br>fun [LongArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long-array/index.html).[toByteArray](to-byte-array.md)(order: [Endian](-endian/index.md) = Endian.Big): [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)<br>Converts this [LongArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long-array/index.html) into a [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) by converting each [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) in this array into a [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) with the provided [order](to-byte-array.md) and appending the results. |
 | [toInt](to-int.md) | [common]<br>fun [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html).[toInt](to-int.md)(startInclusive: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 0, endExclusive: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = size, order: [Endian](-endian/index.md) = Endian.Big): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>Converts the specified indices of this [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) into an [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) value in the provider [order](to-int.md). |
 | [toLong](to-long.md) | [common]<br>fun [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html).[toLong](to-long.md)(startInclusive: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 0, endExclusive: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = size, order: [Endian](-endian/index.md) = Endian.Big): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)<br>Converts the specified indices of this [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) into a [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) value in the provider [order](to-long.md). |
 | [toMultiplatformKey](../../../krypt-core/krypt-core/com.chrynan.krypt.core/[jvm]to-multiplatform-key.md) | [android, jvm]<br>[android]<br>fun [Key](https://developer.android.com/reference/kotlin/java/security/Key.html).[toMultiplatformKey]([android]to-multiplatform-key.md)(): [Key](../../../krypt-core/krypt-core/com.chrynan.krypt.core/-key/index.md)<br>[jvm]<br>fun [Key](https://developer.android.com/reference/kotlin/java/security/Key.html).[toMultiplatformKey]([jvm]to-multiplatform-key.md)(): [Key](../../../krypt-core/krypt-core/com.chrynan.krypt.core/-key/index.md)<br>Converts this [java.security.Key](https://developer.android.com/reference/kotlin/java/security/Key.html) to a [Key](../../../krypt-core/krypt-core/com.chrynan.krypt.core/-key/index.md) instance from this krypt library. |
+| [toMultiplatformKeyPair](../../../krypt-core/krypt-core/com.chrynan.krypt.core/[jvm]to-multiplatform-key-pair.md) | [android, jvm]<br>[android]<br>fun [KeyPair](https://developer.android.com/reference/kotlin/java/security/KeyPair.html).[toMultiplatformKeyPair]([android]to-multiplatform-key-pair.md)(): [KeyPair](../../../krypt-core/krypt-core/com.chrynan.krypt.core/-key-pair/index.md)&lt;[Key](../../../krypt-core/krypt-core/com.chrynan.krypt.core/-key/index.md), [Key](../../../krypt-core/krypt-core/com.chrynan.krypt.core/-key/index.md)&gt;<br>[jvm]<br>fun [KeyPair](https://developer.android.com/reference/kotlin/java/security/KeyPair.html).[toMultiplatformKeyPair]([jvm]to-multiplatform-key-pair.md)(): [KeyPair](../../../krypt-core/krypt-core/com.chrynan.krypt.core/-key-pair/index.md)&lt;[Key](../../../krypt-core/krypt-core/com.chrynan.krypt.core/-key/index.md), [Key](../../../krypt-core/krypt-core/com.chrynan.krypt.core/-key/index.md)&gt;<br>Converts this [java.security.KeyPair](https://developer.android.com/reference/kotlin/java/security/KeyPair.html) to a [KeyPair](../../../krypt-core/krypt-core/com.chrynan.krypt.core/-key-pair/index.md) instance from this krypt library. |
 | [toSecureString](to-secure-string.md) | [common]<br>fun [CharSequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html).[toSecureString](to-secure-string.md)(): [SecureString](-secure-string/index.md)<br>fun [CharArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-array/index.html).[toSecureString](to-secure-string.md)(eraseSource: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true): [SecureString](-secure-string/index.md) |

docs/krypt-core/krypt-core/com.chrynan.krypt.core/invoke.md

@@ -9,15 +9,15 @@ A function that can generate a HMAC (Hash-based message authentication code). A
 
 Any cryptographic hash function may be used in the calculation of a HMAC. This function, which represents the calculation of a HMAC, takes a [hash](invoke.md) parameter which is a [HashFunction](-hash-function/index.md) with an input and output of [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html).
 
-## See also
+#### See also
 
 common
 
 | | |
 |---|---|
 |  | [Wikipedia Explanation](https://en.wikipedia.org/wiki/HMAC) |
 
-## Parameters
+#### Parameters
 
 common
 
@@ -33,13 +33,13 @@ suspend operator fun [HMAC.Companion](-h-m-a-c/-companion/index.md).[invoke](inv
 
 A convenience function for invoking the [invoke](invoke.md) function with the provided [key](-key/index.md) value.
 
-## See also
+#### See also
 
 common
 
-| | |
-|---|---|
-| [invoke](invoke.md) |  |
+| |
+|---|
+| [invoke](invoke.md) |
 
 [common]\
 operator fun [SecureString.Companion](-secure-string/-companion/index.md).[invoke](invoke.md)(charSequence: [CharSequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html)): [SecureString](-secure-string/index.md)