Add documentation to link public APIs

MohamedRejeb · Apr 7, 2024 · d60d646 · d60d646
1 parent a71dc10
commit d60d646
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/richeditor-compose/src/commonMain/kotlin/com/mohamedrejeb/richeditor/model/RichTextState.kt b/richeditor-compose/src/commonMain/kotlin/com/mohamedrejeb/richeditor/model/RichTextState.kt
@@ -272,6 +272,9 @@ class RichTextState internal constructor(
     /**
      * Add a link to the text field.
      * The link is going to be added after the current selection.
+     *
+     * @param text the text of the link.
+     * @param url the URL of the link.
      */
     fun addLink(
         text: String,
@@ -307,6 +310,8 @@ class RichTextState internal constructor(
 
     /**
      * Add a link to the selected text.
+     *
+     * @param url the URL of the link.
      */
     fun addLinkToSelection(
         url: String,
@@ -327,6 +332,8 @@ class RichTextState internal constructor(
 
     /**
      * Update the link of the selected text.
+     *
+     * @param url the new URL of the link.
      */
     fun updateLink(
         url: String,