build: Restore comments removed during GutenbergKit v0.15.0 upgrade

Re-add section-organizing and explanatory comments that were
accidentally dropped in the API migration. Only comments whose
described code still exists are restored.

Author: jkmassel

WordPress/src/main/java/org/wordpress/android/ui/posts/EditorConfigurationBuilder.kt

@@ -26,11 +26,13 @@ object EditorConfigurationBuilder {
             val postId = settings.getSetting<Int>("postId")
                 ?.let { if (it == 0) null else it.toUInt() }
 
+            // Post settings
             setTitle(settings.getSetting<String>("postTitle") ?: "")
             setContent(settings.getSetting<String>("postContent") ?: "")
             setPostId(postId)
             setPostStatus(settings.getSetting<String>("status") ?: "draft")
 
+            // Site settings
             setSiteApiNamespace(siteApiNamespace)
             setNamespaceExcludedPaths(
                 settings.getStringArray("namespaceExcludedPaths")
@@ -39,6 +41,7 @@ object EditorConfigurationBuilder {
                 settings.getSetting<String>("authHeader") ?: ""
             )
 
+            // Features
             setThemeStyles(
                 settings.getSettingOrDefault("themeStyles", false)
             )
@@ -47,15 +50,18 @@ object EditorConfigurationBuilder {
             )
             setLocale(settings.getSetting<String>("locale") ?: "en")
 
+            // Editor asset caching configuration
             configureEditorAssetCaching(
                 settings, siteURL, siteApiNamespace
             )
 
+            // Cookies
             setCookies(
                 settings.getSetting<Map<String, String>>("cookies")
                     ?: emptyMap()
             )
 
+            // Network logging for debugging
             setEnableNetworkLogging(
                 settings.getSettingOrDefault("enableNetworkLogging", false)
             )
@@ -87,6 +93,7 @@ object EditorConfigurationBuilder {
         }
     }
 
+    // Type-safe settings accessors
     private inline fun <reified T> Map<String, Any?>.getSetting(
         key: String
     ): T? = this[key] as? T

WordPress/src/main/java/org/wordpress/android/ui/posts/editor/GutenbergKitEditorFragment.kt

@@ -68,19 +68,22 @@ class GutenbergKitEditorFragment : GutenbergKitEditorFragmentBase() {
     }
 
     private fun initializeFragmentListeners() {
+        // Set up history change listener
         historyChangeListener = object : HistoryChangeListener {
             override fun onHistoryChanged(hasUndo: Boolean, hasRedo: Boolean) {
                 mEditorFragmentListener.onToggleUndo(!hasUndo)
                 mEditorFragmentListener.onToggleRedo(!hasRedo)
             }
         }
 
+        // Set up featured image change listener
         featuredImageChangeListener = object : FeaturedImageChangeListener {
             override fun onFeaturedImageChanged(mediaID: Long) {
                 mEditorFragmentListener.onFeaturedImageIdChanged(mediaID, true)
             }
         }
 
+        // Set up media library listener
         openMediaLibraryListener = object : OpenMediaLibraryListener {
             override fun onOpenMediaLibrary(
                 config: GutenbergView.OpenMediaLibraryConfig
@@ -89,6 +92,7 @@ class GutenbergKitEditorFragment : GutenbergKitEditorFragmentBase() {
             }
         }
 
+        // Set up JS exception listener
         onLogJsExceptionListener = object : LogJsExceptionListener {
             override fun onLogJsException(
                 exception: org.wordpress.gutenberg.GutenbergJsException
@@ -125,6 +129,7 @@ class GutenbergKitEditorFragment : GutenbergKitEditorFragmentBase() {
             }
         }
 
+        // Set up modal dialog state listener
         modalDialogStateListener = object : GutenbergView.ModalDialogStateListener {
             override fun onModalDialogOpened(dialogType: String) {
                 mEditorFragmentListener.onModalDialogOpened(dialogType)
@@ -140,6 +145,7 @@ class GutenbergKitEditorFragment : GutenbergKitEditorFragmentBase() {
     override fun onCreateView(
         inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?
     ): View? {
+        // Set up fragment's own listeners before initializing the editor
         initializeFragmentListeners()
 
         mEditorFragmentListener.onEditorFragmentInitialized()
@@ -221,6 +227,7 @@ class GutenbergKitEditorFragment : GutenbergKitEditorFragmentBase() {
                         "at-symbol" ->
                             mEditorFragmentListener.showUserSuggestions { result ->
                                 result?.let {
+                                    // Appended space completes the autocomplete session
                                     gutenbergView.appendTextAtCursor("$it ")
                                 }
                             }
@@ -229,6 +236,7 @@ class GutenbergKitEditorFragment : GutenbergKitEditorFragmentBase() {
                                 mEditorFragmentListener
                                     .showXpostSuggestions { result ->
                                         result?.let {
+                                            // Appended space completes the autocomplete session
                                             gutenbergView
                                                 .appendTextAtCursor("$it ")
                                         }
@@ -452,6 +460,10 @@ class GutenbergKitEditorFragment : GutenbergKitEditorFragmentBase() {
     override fun appendMediaFiles(
         mediaList: MutableMap<String?, MediaFile?>
     ) {
+        // appendMediaFile may be called from a background thread
+        // (example: EditPostActivity.java#L2165) and Activity may
+        // have already be gone.
+        // Ticket: https://github.com/wordpress-mobile/WordPress-Android/issues/7386
         if (activity == null) {
             AppLog.d(
                 AppLog.T.MEDIA,
@@ -460,6 +472,8 @@ class GutenbergKitEditorFragment : GutenbergKitEditorFragmentBase() {
             return
         }
 
+        // Get media URL of first of media first to check
+        // if it is network or local one.
         var mediaUrl: String? = ""
         val mediaUrls: Array<Any?> = mediaList.keys.toTypedArray()
         if (mediaUrls.isNotEmpty()) {
@@ -468,6 +482,7 @@ class GutenbergKitEditorFragment : GutenbergKitEditorFragmentBase() {
 
         val isNetworkUrl = URLUtil.isNetworkUrl(mediaUrl)
 
+        // Disable upload handling until supported--e.g., media shared to the app
         if (gutenbergView == null || !isNetworkUrl) {
             return
         }