Add documentation to source files (#13)

Author: 05nelsonm

library/hmac/hmac-md5/src/commonMain/kotlin/org/kotlincrypto/macs/HmacMD5.kt

@@ -23,6 +23,11 @@ import org.kotlincrypto.hash.Md5
 
 public class HmacMD5: Hmac {
 
+    /**
+     * Instantiates a new instance of [HmacMD5].
+     *
+     * @throws [IllegalArgumentException] if [key] is empty.
+     * */
     @OptIn(InternalKotlinCryptoApi::class)
     @Throws(IllegalArgumentException::class)
     public constructor(key: ByteArray): super(key, "HmacMD5", Md5())

library/hmac/hmac-sha1/src/commonMain/kotlin/org/kotlincrypto/macs/HmacSHA1.kt

@@ -23,6 +23,11 @@ import org.kotlincrypto.hash.Sha1
 
 public class HmacSHA1: Hmac {
 
+    /**
+     * Instantiates a new instance of [HmacSHA1].
+     *
+     * @throws [IllegalArgumentException] if [key] is empty.
+     * */
     @OptIn(InternalKotlinCryptoApi::class)
     @Throws(IllegalArgumentException::class)
     public constructor(key: ByteArray): super(key, "HmacSHA1", Sha1())

library/hmac/hmac-sha2-256/src/commonMain/kotlin/org/kotlincrypto/macs/HmacSHA256.kt

@@ -23,6 +23,11 @@ import org.kotlincrypto.hash.Sha256
 
 public class HmacSHA256: Hmac {
 
+    /**
+     * Instantiates a new instance of [HmacSHA256].
+     *
+     * @throws [IllegalArgumentException] if [key] is empty.
+     * */
     @OptIn(InternalKotlinCryptoApi::class)
     @Throws(IllegalArgumentException::class)
     public constructor(key: ByteArray): super(key, "HmacSHA256", Sha256())

library/hmac/hmac-sha2-512/src/commonMain/kotlin/org/kotlincrypto/macs/HmacSHA512.kt

@@ -23,6 +23,11 @@ import org.kotlincrypto.hash.Sha512
 
 public class HmacSHA512: Hmac {
 
+    /**
+     * Instantiates a new instance of [HmacSHA512].
+     *
+     * @throws [IllegalArgumentException] if [key] is empty.
+     * */
     @OptIn(InternalKotlinCryptoApi::class)
     @Throws(IllegalArgumentException::class)
     public constructor(key: ByteArray): super(key, "HmacSHA512", Sha512())

library/hmac/hmac/src/commonMain/kotlin/org/kotlincrypto/macs/Hmac.kt

@@ -32,6 +32,11 @@ import kotlin.jvm.JvmSynthetic
  * */
 public abstract class Hmac: Mac {
 
+    /**
+     * Primary constructor for creating a new [Hmac] instance
+     *
+     * @throws [IllegalArgumentException] if [key] is empty.
+     * */
     @InternalKotlinCryptoApi
     @Throws(IllegalArgumentException::class)
     protected constructor(
@@ -40,6 +45,12 @@ public abstract class Hmac: Mac {
         digest: Digest,
     ): super(algorithm, Engine.instance(key, digest))
 
+    /**
+     * Secondary constructor for implementing [copy].
+     *
+     * Implementors of [Hmac] should have a private secondary constructor
+     * that is utilized by its [copy] implementation.
+     * */
     @InternalKotlinCryptoApi
     protected constructor(
         algorithm: String,