-added docStrings

Signed-off-by: Fabian Seitz <[email protected]>
amosproj · Jan 31, 2024 · 9d64f18 · 9d64f18
1 parent 23cae4e
commit 9d64f18
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/DifferenceGenerator/src/main/kotlin/AcceptedCodecs.kt b/DifferenceGenerator/src/main/kotlin/AcceptedCodecs.kt
@@ -20,6 +20,9 @@ class AcceptedCodecs {
                 "FFV1 YUV 422 8-bit",
             )
 
+        /**
+         * Checks if the given file is in an accepted codec.
+         */
         public fun checkFile(path: String): Boolean {
             val grabber = FFmpegFrameGrabber(path)
             grabber.start()

diff --git a/GUI/src/main/kotlin/ui/screens/SelectVideoScreen.kt b/GUI/src/main/kotlin/ui/screens/SelectVideoScreen.kt
@@ -102,6 +102,9 @@ fun SelectVideoScreen(state: MutableState<AppState>) {
     }
 }
 
+/**
+ * Checks if the selected file is in the correct format and codec.
+ */
 private fun checkVideoFormatAndCodec(
     selectedFilePath: String,
     state: MutableState<AppState>,