Skip to content

Commit 5be377f

Browse files
committed
Documentation improvements
1 parent d797c76 commit 5be377f

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,11 @@ Message Authentication Code algorithms for Kotlin Multiplatform
3030
See [HERE][url-core-usage] for basic usage example for `Mac`.
3131

3232
```kotlin
33+
// Using SecureRandom from the secure-random repo as an example
3334
import org.kotlincrypto.SecureRandom
35+
// ...
3436

3537
fun main() {
36-
// NOTE: SecureRandom is not included as a dependency in
37-
// MACs. It is only being used here as an example
38-
// because one should never derive a key using Random.
3938
val key = SecureRandom().nextBytesOf(100)
4039

4140
// Hmacs that may be needed for backward compatibility but
@@ -82,7 +81,7 @@ fun main() {
8281
<!-- TODO: Uncomment
8382
`SHA3 KMAC & XOFs` (i.e. [Extendable-Output Functions][url-pub-xof])
8483
85-
See [HERE][url-core-usage] for details on what XOFs are, and a basic usage example for Xof.
84+
See [HERE][url-core-usage] for details on what `XOFs` are, and a basic usage example for `Xof`.
8685
8786
```kotlin
8887
fun main() {

library/kmac/src/commonMain/kotlin/org/kotlincrypto/macs/KMAC128.kt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ import kotlin.jvm.JvmStatic
2222

2323
/**
2424
* KMAC128 implementation
25+
*
26+
* @see [xOf]
2527
* */
2628
public class KMAC128: Kmac {
2729

library/kmac/src/commonMain/kotlin/org/kotlincrypto/macs/KMAC256.kt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ import kotlin.jvm.JvmStatic
2222

2323
/**
2424
* KMAC128 implementation
25+
*
26+
* @see [xOf]
2527
* */
2628
public class KMAC256: Kmac {
2729

0 commit comments

Comments
 (0)