docs: media.addFile

Author: david-allison

AnkiDroid/src/main/java/com/ichi2/anki/servicelayer/NoteService.kt

@@ -42,6 +42,7 @@ import com.ichi2.anki.observability.undoableOp
 import org.json.JSONException
 import timber.log.Timber
 import java.io.File
+import java.io.IOException
 
 object NoteService {
     /**
@@ -123,6 +124,9 @@ object NoteService {
      * Considering the field is new, if it has media handle it
      *
      * @param field
+     *
+     * @throws IOException
+     * @throws OutOfMemoryError if the file could not be copied to a contiguous block of memory (or is >= 2GB)
      */
     fun importMediaToDirectory(
         col: Collection,

libanki/src/main/java/com/ichi2/anki/libanki/Media.kt

@@ -61,6 +61,10 @@ open class Media(
      ***********************************************************
      */
 
+    /**
+     * @throws EmptyMediaException if [oFile] is empty or null
+     * @throws OutOfMemoryError if the file could not be copied to a contiguous block of memory (or is >= 2GB)
+     */
     fun addFile(oFile: File?): String {
         if (oFile == null || oFile.length() == 0L) {
             throw EmptyMediaException()

libanki/src/main/java/com/ichi2/anki/libanki/exception/EmptyMediaException.kt

@@ -15,5 +15,9 @@
  */
 package com.ichi2.anki.libanki.exception
 
-// Empty media files cannot be added to AnkiWeb
+/**
+ * Exception raised when attempting to add an empty, or non-existing media file
+ *
+ * Empty media files cannot be added to AnkiWeb
+ */
 class EmptyMediaException : Exception()