Add some KDoc to explain the reason behind the IntRange for font size

Infomaniak · Jun 19, 2024 · 2fc86f4 · 2fc86f4
1 parent d3be6ac
commit 2fc86f4
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/rich-html-editor/src/main/java/com/infomaniak/lib/richhtmleditor/RichHtmlEditorWebView.kt b/rich-html-editor/src/main/java/com/infomaniak/lib/richhtmleditor/RichHtmlEditorWebView.kt
@@ -129,6 +129,13 @@ class RichHtmlEditorWebView @JvmOverloads constructor(
     fun removeFormat() = jsBridge.removeFormat()
     fun setTextColor(@ColorInt color: Int) = jsBridge.setTextColor(JsColor(color))
     fun setTextBackgroundColor(@ColorInt color: Int) = jsBridge.setTextBackgroundColor(JsColor(color))
+
+    /**
+     * Updates the font size of the text.
+     *
+     * @param fontSize The new size of the text. This value's range constraint comes from the JavaScript `execCommand` method
+     * called with the argument `fontSize`.
+     */
     fun setFontSize(@IntRange(from = FONT_MIN_SIZE, to = FONT_MAX_SIZE) fontSize: Int) = jsBridge.setFontSize(fontSize)
     fun createLink(displayText: String?, url: String) = jsBridge.createLink(displayText?.takeIf { it.isNotBlank() }, url)
     fun unlink() = jsBridge.unlink()