docs(image-occlusion): more KDocs

Author: david-allison

AnkiDroid/src/main/java/com/ichi2/anki/pages/ImageOcclusion.kt

@@ -44,6 +44,20 @@ import com.ichi2.anki.startDeckSelection
 import kotlinx.coroutines.launch
 import timber.log.Timber
 
+/**
+ * Page provided by the backend, for a user to add or edit an image occlusion (IO) note
+ *
+ * IO: Like an image-based cloze: hide parts of an image, revealed on the back
+ * ([docs](https://docs.ankiweb.net/editing.html#image-occlusion) and
+ * [source](https://github.com/ankitects/anki/blob/main/proto/anki/image_occlusion.proto)).
+ *
+ * **Paths**
+ * `/image-occlusion/$PATH`
+ * `/image-occlusion/$NOTE_ID`
+ *
+ * @see ImageOcclusionViewModel
+ * @see ImageOcclusion.getIntent
+ */
 class ImageOcclusion :
     PageFragment(R.layout.image_occlusion),
     DeckSelectionDialog.DeckSelectionListener {

AnkiDroid/src/main/java/com/ichi2/anki/pages/viewmodel/ImageOcclusionViewModel.kt

@@ -52,8 +52,10 @@ class ImageOcclusionViewModel(
     val oldDeckId: Long
 
     /**
-     * A [JSONObject] containing options for initializing the WebView. This includes
-     * the type of operation ("add" or "edit"), and relevant IDs and paths.
+     * A [JSONObject] containing options for loading the [image occlusion page][ImageOcclusion].
+     * This includes the type of operation ("add" or "edit"), and relevant IDs and paths.
+     *
+     * Defined in https://github.com/ankitects/anki/blob/main/ts/routes/image-occlusion/lib.ts
      */
     val webViewOptions: JSONObject
 
@@ -86,6 +88,9 @@ class ImageOcclusionViewModel(
         return true
     }
 
+    /**
+     * Executed when the 'save' operation is completed, before the UI receives the response
+     */
     fun onSaveOperationCompleted() {
         Timber.i("save operation completed")
         if (oldDeckId == selectedDeckId) return