docs: add docs to Index & patches

also typed the patches array
E85Addict · Mar 21, 2022 · bdd7cc4 · bdd7cc4
1 parent 4f81a1c
commit bdd7cc4
Showing 1 changed file with 11 additions and 3 deletions.
diff --git a/src/main/kotlin/net/revanced/patches/Index.kt b/src/main/kotlin/net/revanced/patches/Index.kt
@@ -1,13 +1,21 @@
 package net.revanced.patches
 
+import net.revanced.patcher.patch.Patch
 import net.revanced.patches.ads.VideoAds
 import net.revanced.patches.layouts.CreateButtonRemover
 import net.revanced.patches.layouts.MinimizedPlayback
+import kotlin.reflect.KClass
 
-// This object contains all the patches and should be imported when using this library
+/**
+ * Index contains all the patches and should be imported when using this library.
+ */
+@Suppress("Unused")
 object Index {
-    // Array of patches. New patches should be added to the array
-    val patches = arrayOf(
+    /**
+     * Array of patches.
+     * New patches should be added to the array.
+     */
+    val patches: Array<KClass<out Patch>> = arrayOf(
         VideoAds::class,
         MinimizedPlayback::class,
         CreateButtonRemover::class