From 5f7d8a90770a697fde245dafa012f5b0ff72494f Mon Sep 17 00:00:00 2001
From: thunderbiscuit <thunderbiscuit@protonmail.com>
Date: Tue, 10 Jan 2023 14:41:38 -0500
Subject: [PATCH] Fix typos in Kotlin API docs

---
 .../src/main/kotlin/org/bitcoindevkit/bdk.kt  | 70 +++++++++----------
 1 file changed, 35 insertions(+), 35 deletions(-)

diff --git a/api-docs/kotlin/src/main/kotlin/org/bitcoindevkit/bdk.kt b/api-docs/kotlin/src/main/kotlin/org/bitcoindevkit/bdk.kt
index 658fcd1..6fa4ad1 100644
--- a/api-docs/kotlin/src/main/kotlin/org/bitcoindevkit/bdk.kt
+++ b/api-docs/kotlin/src/main/kotlin/org/bitcoindevkit/bdk.kt
@@ -153,7 +153,7 @@ data class EsploraConfig(
 )
 
 /**
- * Authentication mechanism for RPC connection to full node
+ * Authentication mechanism for RPC connection to full node.
  */
 sealed class Auth {
     /** No authentication */
@@ -538,22 +538,22 @@ class DerivationPath(path: String) {}
  * @sample org.bitcoindevkit.descriptorSecretKeyExtendSample
  */
 class DescriptorSecretKey(network: Network, mnemonic: Mnemonic, password: String?) {
-    /* Build a DescriptorSecretKey from a String */
+    /** Build a DescriptorSecretKey from a String */
     fun fromString(secretKey: String): DescriptorSecretKey {}
 
-    /* Derive a private descriptor at a given path. */
+    /** Derive a private descriptor at a given path. */
     fun derive(path: DerivationPath): DescriptorSecretKey {}
 
     /** Extend the private descriptor with a custom path. */
     fun extend(path: DerivationPath): DescriptorSecretKey {}
 
-    /* Return the public version of the descriptor. */
+    /** Return the public version of the descriptor. */
     fun asPublic(): DescriptorPublicKey {}
 
-    /* Return the raw private key as bytes. */
+    /** Return the raw private key as bytes. */
     fun secretBytes(): List<UByte>
 
-    /* Return the private descriptor as a string. */
+    /** Return the private descriptor as a string. */
     fun asString(): String {}
 }
 
@@ -582,7 +582,7 @@ class DescriptorPublicKey(network: Network, mnemonic: String, password: String?)
  * A output descriptor.
  *
  * @param descriptor The descriptor in string format.
- * @param network The network this DescriptorPublicKey is to be used on.
+ * @param network The network this descriptor is to be used on.
  *
  * @sample org.bitcoindevkit.descriptorTemplates1
  * @sample org.bitcoindevkit.descriptorTemplates2
@@ -636,22 +636,22 @@ class Descriptor(descriptor: String, network: Network) {
 
 /**
  * An enum describing entropy length (aka word count) in the mnemonic.
-*/
+ */
 enum class WordCount {
-/** 12 words mnemonic (128 bits entropy). */
-WORDS12,
+    /** 12 words mnemonic (128 bits entropy). */
+    WORDS12,
 
-/** 15 words mnemonic (160 bits entropy). */
-WORDS15,
+    /** 15 words mnemonic (160 bits entropy). */
+    WORDS15,
 
-/** 18 words mnemonic (192 bits entropy). */
-WORDS18,
+    /** 18 words mnemonic (192 bits entropy). */
+    WORDS18,
 
-/** 21 words mnemonic (224 bits entropy). */
-WORDS21,
+    /** 21 words mnemonic (224 bits entropy). */
+    WORDS21,
 
-/** 24 words mnemonic (256 bits entropy). */
-WORDS24,
+    /** 24 words mnemonic (256 bits entropy). */
+    WORDS24,
 }
 
 /**
@@ -662,25 +662,25 @@ WORDS24,
  *
  * @sample org.bitcoindevkit.txBuilderResultSample1
  * @sample org.bitcoindevkit.txBuilderResultSample2
-*/
+ */
 data class TxBuilderResult (
-var psbt: PartiallySignedBitcoinTransaction,
-var transactionDetails: TransactionDetails
+    var psbt: PartiallySignedBitcoinTransaction,
+    var transactionDetails: TransactionDetails
 )
 
 /**
  * A bitcoin script.
-*/
+ */
 class Script(rawOutputScript: List<UByte>)
 
 /**
  * A bitcoin address.
  *
  * @param address The address in string format.
-*/
+ */
 class Address(address: String) {
-/* Return the ScriptPubKey. */
-fun scriptPubkey(): Script
+    /** Return the ScriptPubKey. */
+    fun scriptPubkey(): Script
 }
 
 /**
@@ -690,17 +690,17 @@ fun scriptPubkey(): Script
  * @param mnemonic The mnemonic as a string of space-separated words.
  *
  * @sample org.bitcoindevkit.mnemonicSample
-*/
+ */
 class Mnemonic(mnemonic: String) {
-/* Returns Mnemonic as string */
-fun asString(): String
+    /* Returns Mnemonic as string */
+    fun asString(): String
 
-/* Parse a Mnemonic from a given string. */
-fun fromString(): Mnemonic
+    /* Parse a Mnemonic from a given string. */
+    fun fromString(): Mnemonic
 
-/*
- * Create a new Mnemonic in the specified language from the given entropy. Entropy must be a
- * multiple of 32 bits (4 bytes) and 128-256 bits in length.
-*/
-fun fromEntropy(): Mnemonic
+    /*
+     * Create a new Mnemonic in the specified language from the given entropy. Entropy must be a
+     * multiple of 32 bits (4 bytes) and 128-256 bits in length.
+     */
+    fun fromEntropy(): Mnemonic
 }