docs: MediaRegistration errors

Author: david-allison

AnkiDroid/src/main/java/com/ichi2/anki/MediaRegistration.kt

@@ -44,16 +44,21 @@ object MediaRegistration {
      * Represents different types of media errors.
      */
     sealed class MediaError {
+        /** [Something wrong wrong][R.string.multimedia_editor_something_wrong] */
         data object GenericError : MediaError()
 
+        /** [Error converting clipboard image to png][R.string.multimedia_editor_png_paste_error] */
         class ConversionError(
             val message: String,
         ) : MediaError()
 
+        /** [The image is too large, please insert the image manually][R.string.note_editor_image_too_large] */
         data object ImageTooLarge : MediaError()
 
+        /** [The video file is too large, please insert the video manually][R.string.note_editor_video_too_large] */
         data object VideoTooLarge : MediaError()
 
+        /** [The audio file is too large, please insert the audio manually][R.string.note_editor_audio_too_large] */
         data object AudioTooLarge : MediaError()
 
         fun toHumanReadableString(context: Context): String =
@@ -144,6 +149,8 @@ object MediaRegistration {
      * Loads media into the collection.media directory and returns a HTML reference
      * @param uri The uri of the image to load
      * @return HTML referring to the loaded image
+     *
+     * @throws OutOfMemoryError if the file could not be copied to a contiguous block of memory (or is >= 2GB)
      */
     // TODO: remove the Android dependencies and handle them outside the method
     @Throws(IOException::class)
@@ -222,6 +229,9 @@ object MediaRegistration {
         return true
     }
 
+    /**
+     * @throws OutOfMemoryError if the file could not be copied to a contiguous block of memory (or is >= 2GB)
+     */
     @CheckResult
     fun registerMediaForWebView(mediaPath: File?): Boolean {
         if (mediaPath == null) {