library: Optimize some comments

miuix-kotlin-multiplatform · Sep 28, 2024 · 997ccbf · 997ccbf
1 parent 313b6eb
commit 997ccbf
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 9 deletions.
diff --git a/composeApp/src/commonMain/kotlin/utils/FPSMonitor.kt b/composeApp/src/commonMain/kotlin/utils/FPSMonitor.kt
@@ -13,7 +13,9 @@ import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.withContext
 import top.yukonga.miuix.kmp.basic.Text
 
-// This is a simple FPS monitor that displays the current frames per second.
+/**
+ * A simple FPS monitor that displays the current frames per second.
+ */
 @Composable
 fun FPSMonitor(modifier: Modifier = Modifier) {
     var fps by remember { mutableStateOf(0) }

diff --git a/miuix/src/androidMain/kotlin/top/yukonga/miuix/kmp/extra/SuperDropdown.android.kt b/miuix/src/androidMain/kotlin/top/yukonga/miuix/kmp/extra/SuperDropdown.android.kt
@@ -4,6 +4,8 @@ import android.annotation.SuppressLint
 import androidx.compose.runtime.MutableState
 import androidx.compose.ui.Modifier
 
-/**Returns modifier to be used for the current platform */
+/**
+ * Returns modifier to be used for the current platform.
+ */
 @SuppressLint("ModifierFactoryExtensionFunction")
 actual fun modifierPlatform(modifier: Modifier, isHovered: MutableState<Boolean>): Modifier = modifier
diff --git a/miuix/src/commonMain/kotlin/top/yukonga/miuix/kmp/basic/TextField.kt b/miuix/src/commonMain/kotlin/top/yukonga/miuix/kmp/basic/TextField.kt
@@ -38,7 +38,7 @@ import top.yukonga.miuix.kmp.utils.squircleshape.SquircleShape
  *
  * @param value The input [TextFieldValue] to be shown in the text field.
  * @param onValueChange The callback that is triggered when the input service updates values in
- *  *   [TextFieldValue]. An updated [TextFieldValue] comes as a parameter of the callback.
+ *   [TextFieldValue]. An updated [TextFieldValue] comes as a parameter of the callback.
  * @param modifier The modifier to be applied to the [TextField].
  * @param insideMargin The margin inside the [TextField].
  * @param backgroundColor The background color of the [TextField].

diff --git a/miuix/src/commonMain/kotlin/top/yukonga/miuix/kmp/extra/SuperDropdown.kt b/miuix/src/commonMain/kotlin/top/yukonga/miuix/kmp/extra/SuperDropdown.kt
@@ -67,7 +67,9 @@ import top.yukonga.miuix.kmp.utils.getWindowSize
 import top.yukonga.miuix.kmp.utils.squircleshape.SquircleShape
 import kotlin.math.roundToInt
 
-/**Returns modifier to be used for the current platform */
+/**
+ * Returns modifier to be used for the current platform.
+ */
 expect fun modifierPlatform(modifier: Modifier, isHovered: MutableState<Boolean>): Modifier
 
 /**

diff --git a/miuix/src/commonMain/kotlin/top/yukonga/miuix/kmp/utils/Utils.kt b/miuix/src/commonMain/kotlin/top/yukonga/miuix/kmp/utils/Utils.kt
@@ -13,15 +13,19 @@ enum class Platform {
     WasmJs
 }
 
-/** Returns the current platform name */
+/**
+ * Returns the current platform name.
+ */
 expect fun platform(): Platform
 
 /**
  * Window size data class.
  */
 data class WindowSize(val width: Int, val height: Int)
 
-/** Returns the current window size */
+/**
+ * Returns the current window size.
+ */
 @Composable
 expect fun getWindowSize(): WindowSize
 

diff --git a/miuix/src/desktopMain/kotlin/top/yukonga/miuix/kmp/extra/SuperDropdown.desktop.kt b/miuix/src/desktopMain/kotlin/top/yukonga/miuix/kmp/extra/SuperDropdown.desktop.kt
@@ -6,7 +6,9 @@ import androidx.compose.ui.Modifier
 import androidx.compose.ui.input.pointer.PointerEventType
 import androidx.compose.ui.input.pointer.onPointerEvent
 
-/**Returns modifier to be used for the current platform */
+/**
+ * Returns modifier to be used for the current platform.
+ */
 @OptIn(ExperimentalComposeUiApi::class)
 actual fun modifierPlatform(modifier: Modifier, isHovered: MutableState<Boolean>): Modifier = modifier
     .onPointerEvent(PointerEventType.Move) {

diff --git a/miuix/src/iosMain/kotlin/top/yukonga/miuix/kmp/extra/SuperDropdown.ios.kt b/miuix/src/iosMain/kotlin/top/yukonga/miuix/kmp/extra/SuperDropdown.ios.kt
@@ -3,5 +3,7 @@ package top.yukonga.miuix.kmp.extra
 import androidx.compose.runtime.MutableState
 import androidx.compose.ui.Modifier
 
-/**Returns modifier to be used for the current platform */
+/**
+ * Returns modifier to be used for the current platform.
+ */
 actual fun modifierPlatform(modifier: Modifier, isHovered: MutableState<Boolean>): Modifier = modifier
diff --git a/miuix/src/wasmJsMain/kotlin/top/yukonga/miuix/kmp/extra/SuperDropdown.wasmJs.kt b/miuix/src/wasmJsMain/kotlin/top/yukonga/miuix/kmp/extra/SuperDropdown.wasmJs.kt
@@ -6,7 +6,9 @@ import androidx.compose.ui.Modifier
 import androidx.compose.ui.input.pointer.PointerEventType
 import androidx.compose.ui.input.pointer.onPointerEvent
 
-/**Returns modifier to be used for the current platform */
+/**
+ * Returns modifier to be used for the current platform.
+ */
 @OptIn(ExperimentalComposeUiApi::class)
 actual fun modifierPlatform(modifier: Modifier, isHovered: MutableState<Boolean>): Modifier = modifier
     .onPointerEvent(PointerEventType.Move) {