comments and cleanup

ionic-team · Mar 12, 2024 · 3ff1568 · 3ff1568
1 parent 77c2dc4
commit 3ff1568
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/IonicPortals/src/main/kotlin/io/ionic/portals/DevConfiguration.kt b/IonicPortals/src/main/kotlin/io/ionic/portals/DevConfiguration.kt
@@ -1,13 +1,17 @@
 package io.ionic.portals
 
-import android.annotation.SuppressLint
 import android.content.Context
 import com.getcapacitor.CapConfig
-import com.getcapacitor.Logger
 
+/**
+ * This class is used to load the server URL and Capacitor configuration from the assets folder when the app
+ * is being run in developer mode with the Portals CLI.
+ */
 object DevConfiguration {
 
-    @SuppressLint("PrivateApi")
+    /**
+     * Get the server URL for the given portal name from the developer mode assets folder.
+     */
     fun getServerUrl(context: Context, portalName: String): String? {
         val portalDirName = "$portalName.debug"
         val generalDirName = "portal.debug"
@@ -35,7 +39,9 @@ object DevConfiguration {
         return serverUrl
     }
 
-    @SuppressLint("PrivateApi")
+    /**
+     * Get the Capacitor configuration for the given portal name from the developer mode assets folder.
+     */
     fun getCapacitorConfig(context: Context, portalName: String): CapConfig? {
         val portalDirName = "$portalName.debug"
         val generalDirName = "portal.debug"

diff --git a/IonicPortals/src/main/kotlin/io/ionic/portals/PortalView.kt b/IonicPortals/src/main/kotlin/io/ionic/portals/PortalView.kt
@@ -7,8 +7,6 @@ import android.graphics.Canvas
 import android.os.Build
 import android.os.Handler
 import android.util.AttributeSet
-import android.util.Log
-import android.view.LayoutInflater
 import android.view.View
 import android.view.WindowInsets
 import android.widget.FrameLayout