chore(import): add missing kdoc

diegoberaldin · Jul 18, 2023 · 9eacf2d · 9eacf2d
1 parent 9b5c9cd
commit 9eacf2d
Show file tree

Hide file tree

Showing 2 changed files with 68 additions and 0 deletions.
diff --git a/...oberaldin/metaphrase/feature/projects/dialog/export/presentation/ExportDialogComponent.kt b/...oberaldin/metaphrase/feature/projects/dialog/export/presentation/ExportDialogComponent.kt
@@ -18,12 +18,51 @@ interface ExportDialogComponent :
      * View intents.
      */
     sealed interface Intent {
+        /**
+         * Add a language.
+         *
+         * @property value language to add
+         * @constructor Create [AddLanguage]
+         */
         data class AddLanguage(val value: LanguageModel) : Intent
+
+        /**
+         * Remove a language.
+         *
+         * @property value language to remove
+         * @constructor Create [RemoveLanguage]
+         */
         data class RemoveLanguage(val value: LanguageModel) : Intent
+
+        /**
+         * Select resource file type.
+         *
+         * @property value resource type
+         * @constructor Create [SelectType]
+         */
         data class SelectType(val value: ResourceFileType) : Intent
+
+        /**
+         * Set the output path (must be a zip file).
+         *
+         * @property value path to write the messages.
+         * @constructor Create [SetOutputPath]
+         */
         data class SetOutputPath(val value: String) : Intent
+
+        /**
+         * Open a dialog to select a destination path.
+         */
         object OpenFileDialog : Intent
+
+        /**
+         * Close any currently open dialog.
+         */
         object CloseDialog : Intent
+
+        /**
+         * Submit the data.
+         */
         object Submit : Intent
     }
 

diff --git a/...oberaldin/metaphrase/feature/projects/dialog/import/presentation/ImportDialogComponent.kt b/...oberaldin/metaphrase/feature/projects/dialog/import/presentation/ImportDialogComponent.kt
@@ -18,10 +18,39 @@ interface ImportDialogComponent :
      * View intents.
      */
     sealed interface Intent {
+        /**
+         * Select resource file type.
+         *
+         * @property value resource type
+         * @constructor Create [SelectType]
+         */
         data class SelectType(val value: ResourceFileType) : Intent
+
+        /**
+         * Set the input path for a language.
+         *
+         * @property path Resource file path
+         * @property lang Language of the resource file selected
+         * @constructor Create [SetInputPath]
+         */
         data class SetInputPath(val path: String, val lang: String) : Intent
+
+        /**
+         * Open the select file dialog for a language.
+         *
+         * @property lang Language of the resource file selected
+         * @constructor Create [OpenFileDialog]
+         */
         data class OpenFileDialog(val lang: String) : Intent
+
+        /**
+         * Close any currently open dialog.
+         */
         object CloseDialog : Intent
+
+        /**
+         * Submit the data.
+         */
         object Submit : Intent
     }