utils ktdoc cleanup

Author: emyfops

src/main/kotlin/com/lambda/util/EnchantmentUtils.kt

@@ -27,9 +27,6 @@ import net.minecraft.registry.RegistryKey
 import net.minecraft.registry.entry.RegistryEntry
 
 object EnchantmentUtils {
-    /**
-     * Returns the list of enchantments from a given [ItemStack]
-     */
     val ItemStack.enchantments: ItemEnchantmentsComponent
         get() = getOrDefault(DataComponentTypes.ENCHANTMENTS, ItemEnchantmentsComponent.DEFAULT)
 
@@ -40,21 +37,12 @@ object EnchantmentUtils {
         get() = !getOrDefault(DataComponentTypes.ENCHANTMENTS, ItemEnchantmentsComponent.DEFAULT).isEmpty
                 || !getOrDefault(DataComponentTypes.STORED_ENCHANTMENTS, ItemEnchantmentsComponent.DEFAULT).isEmpty
 
-    /**
-     * Returns the given enchantment level from a [net.minecraft.item.ItemStack]
-     */
     fun ItemStack.getEnchantment(key: RegistryKey<Enchantment>) =
         enchantments.enchantmentEntries.find { it.key?.matchesKey(key) == true }?.intValue ?: 0
 
-    /**
-     * Iterates over all the enchantments for the given [ItemStack]
-     */
     fun <T> ItemStack.forEachEnchantment(block: (RegistryEntry<Enchantment>, Int) -> T) =
         enchantments.enchantmentEntries.map { block(it.key, it.intValue) }
 
-    /**
-     * Iterates over all the enchantments of the given [net.minecraft.entity.LivingEntity]'s [EquipmentSlot]
-     */
     fun <T> LivingEntity.forEachSlot(
         vararg slots: EquipmentSlot,
         block: (entry: RegistryEntry<Enchantment>, level: Int) -> T

src/main/kotlin/com/lambda/util/FileUtils.kt

@@ -61,34 +61,17 @@ object FileUtils {
         return path
     }
 
-    /**
-     * Executes the [block] if the file is older than the given [duration]
-     */
     inline fun File.isOlderThan(duration: Duration, block: (File) -> Unit) =
         ifExists { if (duration.inWholeMilliseconds < System.currentTimeMillis() - lastModified()) block(this) }
 
-    /**
-     * Returns whether the receiver file is older than [duration]
-     */
     fun File.isOlderThan(duration: Duration) =
         duration.inWholeMilliseconds < System.currentTimeMillis() - lastModified()
 
-    /**
-     * Executes the [block] if the receiver file exists and is not empty
-     */
     inline fun File.ifExists(block: (File) -> Unit): File {
         if (length() > 0) block(this)
         return this
     }
 
-    /**
-     * Ensures the current file exists by creating it if it does not.
-     *
-     * If the file already exists, it will not be recreated. The necessary
-     * parent directories will be created if they do not exist.
-     *
-     * @param block Lambda executed if the file doesn't exist or the file is empty
-     */
     inline fun File.createIfNotExists(block: (File) -> Unit = {}): File {
         if (length() == 0L) {
             parentFile.mkdirs()
@@ -100,24 +83,15 @@ object FileUtils {
         return this
     }
 
-    /**
-     * Executes the [block] if the receiver file does not exist or is empty.
-     */
     inline fun File.ifNotExists(block: (File) -> Unit): File {
         if (length() == 0L) block(this)
         return this
     }
 
     /**
-     * Modifies the receiver file if the downloaded file compare check succeeds
-     *
-     * @receiver The destination file to write the bytes to
-     *
-     * @param url The url to download the file from
-     * @param compare Compare method. -1 if remote is larger. 0 if both file have the same size. 1 if local is larger
-     * @param block Configuration block for the request
-     *
-     * @return An exception or the file
+     * Changes the local file if [compare]:
+     * - is -1 and the remote is larger
+     * - is 1 and local is larger
      */
     suspend fun File.downloadCompare(
         url: String,
@@ -133,72 +107,21 @@ object FileUtils {
         }
     }
 
-    /**
-     * Downloads the given file url if the file is not present
-     *
-     * @receiver The destination file to write the bytes to
-     *
-     * @param url The url to download the file from
-     * @param block Configuration block for the request
-     *
-     * @return An exception or the file
-     */
     suspend fun File.downloadIfNotPresent(
         url: String,
         block: HttpRequestBuilder.() -> Unit = {},
     ) = runCatching { createIfNotExists { LambdaHttp.download(url, this, block) } }
 
-    /**
-     * Downloads the given file url if the file is not present
-     *
-     * @receiver The url to download the file from
-     *
-     * @param file The destination file to write the bytes to
-     * @param block Configuration block for the request
-     *
-     * @return An exception or the file
-     */
     suspend fun String.downloadIfNotPresent(
         file: File,
         block: HttpRequestBuilder.() -> Unit = {},
     ) = runCatching { file.createIfNotExists { LambdaHttp.download(this, file, block) } }
 
-    /**
-     * Lambda that downloads the given file url if the file is not present
-     *
-     * @receiver The destination file to write the bytes to
-     * @param block Configuration block for the request
-     *
-     * @return A lambda that returns an exception or the file
-     */
-    fun File.downloadIfNotPresent(block: HttpRequestBuilder.() -> Unit = {}): suspend (String) -> Result<Unit> =
-        { url -> runCatching { createIfNotExists { LambdaHttp.download(url, this, block) } } }
-
-    /**
-     * Downloads the given file url if the file is present
-     *
-     * @receiver The destination file to write the bytes to
-     *
-     * @param url The url to download the file from
-     * @param block Configuration block for the request
-     *
-     * @return An exception or the file
-     */
     suspend fun File.downloadIfPresent(
         url: String,
         block: HttpRequestBuilder.() -> Unit = {},
     ) = runCatching { ifExists { LambdaHttp.download(url, this, block) } }
 
-    /**
-     * Downloads the given file url if the file is present
-     *
-     * @receiver The url to download the file from
-     *
-     * @param file The destination file to write the bytes to
-     * @param block Configuration block for the request
-     *
-     * @return An exception or the file
-     */
     suspend fun String.downloadIfPresent(
         file: File,
         block: HttpRequestBuilder.() -> Unit = {},

src/main/kotlin/com/lambda/util/FolderRegister.kt

@@ -31,12 +31,6 @@ import kotlin.io.path.notExists
 
 /**
  * The [FolderRegister] object is responsible for managing the directory structure of the application.
- *
- * @property minecraft The root directory of the Minecraft client.
- * @property lambda The directory for the Lambda client, located within the Minecraft directory.
- * @property config The directory for storing configuration files, located within the Lambda directory.
- * @property packetLogs The directory for storing packet logs, located within the Lambda directory.
- * @property replay The directory for storing replay files, located within the Lambda directory.
  */
 object FolderRegister : Loadable {
     val minecraft: Path = mc.runDirectory.toPath()

src/main/kotlin/com/lambda/util/KeyCode.kt

@@ -155,14 +155,7 @@ enum class KeyCode(val code: Int) {
         private val keyCodeMap = entries.associateBy { it.code }
         private val nameMap = entries.associateBy { it.name.lowercase() }
 
-        /**
-         * Returns the KeyCode enum instance from the key code number or [Unbound] if invalid
-         */
         fun fromKeyCode(keyCode: Int) = keyCodeMap[keyCode] ?: Unbound
-
-        /**
-         * Returns the KeyCode enum instance from the key code name or [Unbound] if invalid
-         */
         fun fromKeyName(name: String) = nameMap[name.lowercase()] ?: Unbound
 
         /**
@@ -172,10 +165,6 @@ enum class KeyCode(val code: Int) {
          * If the key corresponds to a printable character or letter, it is mapped
          * to its corresponding [KeyCode] based on the US layout.
          *
-         * @param keyCode The key code to map.
-         * @param scanCode The scan code of the key.
-         * @return The corresponding [KeyCode].
-         *
          * @see <a href="https://github.com/glfw/glfw/issues/1502#issuecomment-1005841055">ImGui impl
          */
         fun virtualMapUS(keyCode: Int, scanCode: Int): KeyCode {

src/main/kotlin/com/lambda/util/Nameables.kt

@@ -17,9 +17,6 @@
 
 package com.lambda.util
 
-/**
- * @property name represents the name or identifier of the object.
- */
 interface Nameable {
     val name: String
     val commandName get() = name.trim().replace(' ', '_')

src/main/kotlin/com/lambda/util/PacketUtils.kt

@@ -26,17 +26,13 @@ import net.minecraft.network.packet.Packet
 object PacketUtils {
     /**
      * Sends a packet through the regular packet pipeline
-     *
-     * @param block Lambda that returns the packet to be sent
      */
     fun ClientPlayNetworkHandler.sendPacket(block: () -> Packet<*>) = connection.send(block())
 
     /**
      * Sends a packet to the server without notifying the client.
      * It bypasses the mixins that would normally intercept the packet
      * and send it through the client's event bus.
-     *
-     * @param packet The packet to send.
      */
     fun ClientPlayNetworkHandler.sendPacketSilently(packet: Packet<*>) {
         if (!connection.isOpen || connection.packetListener?.accepts(packet) == true) return
@@ -49,8 +45,6 @@ object PacketUtils {
      * Handles a packet without notifying the client.
      * It bypasses the mixins that would normally intercept the packet
      * and send it through the client's event bus.
-     *
-     * @param packet The packet to handle.
      */
     fun ClientPlayNetworkHandler.handlePacketSilently(packet: Packet<*>) {
         if (!connection.isOpen || connection.packetListener?.accepts(packet) == false) return

src/main/kotlin/com/lambda/util/Pointer.kt

@@ -20,11 +20,6 @@ package com.lambda.util
 import kotlin.properties.ReadWriteProperty
 import kotlin.reflect.KProperty
 
-/**
- * A class representing a pointer to a value.
- *
- * It is a high-level abstraction over a mutable variable that allows for easy access to the value.
- */
 data class Pointer<T>(var value: T? = null) : ReadWriteProperty<Any?, T?> {
     override fun getValue(thisRef: Any?, property: KProperty<*>): T? = value
     override fun setValue(thisRef: Any?, property: KProperty<*>, value: T?) {

src/main/kotlin/com/lambda/util/StringUtils.kt

@@ -25,49 +25,31 @@ import kotlin.io.encoding.Base64
 import kotlin.io.encoding.ExperimentalEncodingApi
 
 object StringUtils {
-    /**
-     * Returns a sanitized file path for both Unix and Linux systems
-     */
     fun String.sanitizeForFilename() =
         replace(Regex("[\\\\/:*?\"<>|]"), "_")
             .trim()
             .take(255) // truncate to 255 characters for Windows compatibility
 
 
-    /**
-     * Capitalizes the first character of a string using its Unicode mapping
-     */
     fun String.capitalize() = replaceFirstChar { it.titlecase() }
 
-    /**
-     * Returns a Minecraft [net.minecraft.util.Identifier] from a string with the given namespace
-     */
     fun String.toIdentifier(namespace: String = Lambda.MOD_ID): Identifier =
         Identifier.of(namespace, this)
 
-    /**
-     * Returns a [Lambda] Minecraft [Identifier] from a string
-     */
     val String.asIdentifier: Identifier get() = toIdentifier()
 
     /**
      * Find similar strings in a set of words.
      *
-     * @param target The string to compare against.
-     * @param words The set of words to compare against.
-     * @param threshold The maximum Levenshtein distance between the target and the words.
+     * @see <a href="https://en.wikipedia.org/wiki/Levenshtein_distance">Levenshtein distance</a<
      */
-    fun findSimilarStrings(
-        target: String,
+    fun String.findSimilarStrings(
         words: Set<String>,
         threshold: Int,
-    ) = words.filter { it.levenshteinDistance(target) <= threshold }.toSet()
+    ) = words.filter { it.levenshteinDistance(this) <= threshold }.toSet()
 
     /**
-     * See [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance)
-     *
-     * @receiver The string to compare.
-     * @param rhs The string to compare against.
+     * @see <a href="https://en.wikipedia.org/wiki/Levenshtein_distance">Levenshtein distance</a<
      */
     fun CharSequence.levenshteinDistance(rhs: CharSequence): Int {
         if (this == rhs) {
@@ -108,11 +90,6 @@ object StringUtils {
         return cost[len0 - 1]
     }
 
-    /**
-     * Takes the receiver string and decodes it to the input type
-     *
-     * @return Instance of [T]
-     */
     inline fun <reified T : Any> String.json() = gson.fromJson(this, T::class.java)
 
     /**
@@ -122,39 +99,21 @@ object StringUtils {
     fun String.base64UrlDecode() = Base64.UrlSafe.decode(this).decodeToString()
 
     /**
-     * See [MessageDigest section](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#messagedigest-algorithms) of the Java Security Standard Algorithm Names Specification
-     *
-     * @receiver        The string to hash
-     * @param algorithm The algorithm instance to use
-     * @param extra     Additional data to digest with the string
-     *
-     * @return          The string representation of the hash
+     * @see <a href="https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#messagedigest-algorithms">Java Security Standard Algorithm Names Specification</a>
      */
     fun String.hashString(algorithm: String, vararg extra: ByteArray): String =
         toByteArray().hash(algorithm, *extra)
             .joinToString(separator = "") { "%02x".format(it) }
 
     /**
-     * See [MessageDigest section](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#messagedigest-algorithms) of the Java Security Standard Algorithm Names Specification
-     *
-     * @receiver        The byte array to hash
-     * @param algorithm The algorithm instance to use
-     * @param extra     Additional data to digest with the byte array
-     *
-     * @return          The string representation of the hash
+     * @see <a href="https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#messagedigest-algorithms">Java Security Standard Algorithm Names Specification</a>
      */
     fun ByteArray.hashString(algorithm: String, vararg extra: ByteArray): String =
         hash(algorithm, *extra)
             .joinToString(separator = "") { "%02x".format(it) }
 
     /**
-     * See [MessageDigest section](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#messagedigest-algorithms) of the Java Security Standard Algorithm Names Specification
-     *
-     * @receiver        The byte array to hash
-     * @param algorithm The algorithm instance to use
-     * @param extra     Additional data to digest with the byte array
-     *
-     * @return          The digested data
+     * @see <a href="https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#messagedigest-algorithms">Java Security Standard Algorithm Names Specification</a>
      */
     fun ByteArray.hash(algorithm: String, vararg extra: ByteArray): ByteArray =
         MessageDigest