Fix comment linting errors

Author: jennantilla

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/RootToolsInternalMethods.kt

@@ -1,3 +1,5 @@
+// Namespaced in com.onesignal to prevent class name conflicts if app developer includes the full RootTools library.
+
 /**
  * This file is part of the RootTools Project: http://code.google.com/p/roottools/
  *
@@ -20,7 +22,6 @@
  * limitations under that License.
  */
 
-// Namespaced in com.onesignal to prevent class name conflicts if app developer includes the full RootTools library.
 package com.onesignal.common
 
 import java.io.File

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/backend/impl/ParamsBackendService.kt

@@ -59,7 +59,8 @@ internal class ParamsBackendService(
         return ParamsObject(
             googleProjectNumber = responseJson.safeString("android_sender_id"),
             enterprise = responseJson.safeBool("enterp"),
-            useIdentityVerification = responseJson.safeBool("require_ident_auth"), // TODO: New
+            // TODO: New
+            useIdentityVerification = responseJson.safeBool("require_ident_auth"),
             notificationChannels = responseJson.optJSONArray("chnl_lst"),
             firebaseAnalytics = responseJson.safeBool("fba"),
             restoreTTLFilter = responseJson.safeBool("restore_ttl_filter"),
@@ -69,7 +70,8 @@ internal class ParamsBackendService(
             unsubscribeWhenNotificationsDisabled = responseJson.safeBool("unsubscribe_on_notifications_disabled"),
             locationShared = responseJson.safeBool("location_shared"),
             requiresUserPrivacyConsent = responseJson.safeBool("requires_user_privacy_consent"),
-            opRepoExecutionInterval = responseJson.safeLong("oprepo_execution_interval"), // TODO: New
+            // TODO: New
+            opRepoExecutionInterval = responseJson.safeLong("oprepo_execution_interval"),
             influenceParams = influenceParams ?: InfluenceParamsObject(),
             fcmParams = fcmParams ?: FCMParamsObject(),
         )

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/preferences/IPreferencesService.kt

@@ -162,6 +162,7 @@ object PreferenceStores {
 
 object PreferencePlayerPurchasesKeys {
     // Player Purchase Keys
+
     /**
      * (String) The purchase tokens that have been tracked.
      */
@@ -175,6 +176,7 @@ object PreferencePlayerPurchasesKeys {
 
 object PreferenceOneSignalKeys {
     // Legacy
+
     /**
      * (String) The legacy player ID from SDKs prior to 5.
      */
@@ -186,19 +188,22 @@ object PreferenceOneSignalKeys {
     const val PREFS_LEGACY_USER_SYNCVALUES = "ONESIGNAL_USERSTATE_SYNCVALYES_CURRENT_STATE"
 
     // Location
+
     /**
      * (Long) The last time the device location was captured, in Unix time milliseconds.
      */
     const val PREFS_OS_LAST_LOCATION_TIME = "OS_LAST_LOCATION_TIME"
 
     // Permissions
+
     /**
      * (Boolean) A prefix key for the permission state. When true, the user has rejected this
      * permission too many times and will not be prompted again.
      */
     const val PREFS_OS_USER_RESOLVED_PERMISSION_PREFIX = "USER_RESOLVED_PERMISSION_"
 
     // HTTP
+
     /**
      * (String) A prefix key for retrieving the ETAG for a given HTTP GET cache key. The cache
      * key should be appended to this prefix.
@@ -212,12 +217,14 @@ object PreferenceOneSignalKeys {
     const val PREFS_OS_HTTP_CACHE_PREFIX = "PREFS_OS_HTTP_CACHE_PREFIX_"
 
     // Outcomes
+
     /**
      * (String Set) The set of unattributed outcome events that have occurred to ensure uniqueness when requested.
      */
     const val PREFS_OS_UNATTRIBUTED_UNIQUE_OUTCOME_EVENTS_SENT = "PREFS_OS_UNATTRIBUTED_UNIQUE_OUTCOME_EVENTS_SENT"
 
     // In-App Messaging
+
     /**
      * (String) The serialized IAMs TODO: This isn't currently used, determine if actually needed for cold start IAM fetch delay
      */
@@ -249,6 +256,7 @@ object PreferenceOneSignalKeys {
     const val PREFS_OS_IAM_LAST_DISMISSED_TIME = "PREFS_OS_IAM_LAST_DISMISSED_TIME"
 
     // Models
+
     /**
      * (String) A prefix key for retrieving a specific model store contents.  The name of the model
      * store should be appended to this prefix.

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/session/internal/outcomes/impl/OutcomeEventParams.kt

@@ -5,10 +5,14 @@ import org.json.JSONObject
 
 internal class OutcomeEventParams constructor(
     val outcomeId: String,
-    val outcomeSource: OutcomeSource?, // This field is optional
-    var weight: Float, // This field is optional.
-    var sessionTime: Long, // This field is optional
-    var timestamp: Long, // This should start out as zero
+    // This field is optional
+    val outcomeSource: OutcomeSource?,
+    // This field is optional
+    var weight: Float,
+    // This field is optional
+    var sessionTime: Long,
+    // This should start out as zero
+    var timestamp: Long,
 ) {
     @Throws(JSONException::class)
     fun toJSONObject(): JSONObject {

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/session/internal/outcomes/impl/OutcomeEventsController.kt

@@ -173,7 +173,8 @@ Outcome event was cached and will be reattempted on app cold start""",
     private suspend fun sendAndCreateOutcomeEvent(
         name: String,
         weight: Float,
-        sessionTime: Long, // Note: this is optional
+        // Note: this is optional
+        sessionTime: Long,
         influences: List<Influence>,
     ): OutcomeEvent? {
         val timestampSeconds: Long = _time.currentTimeMillis / 1000

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/session/internal/outcomes/impl/OutcomeEventsPreferences.kt

@@ -17,7 +17,8 @@ internal class OutcomeEventsPreferences(
         set(value) {
             preferences.saveStringSet(
                 PreferenceStores.ONESIGNAL,
-                PreferenceOneSignalKeys.PREFS_OS_UNATTRIBUTED_UNIQUE_OUTCOME_EVENTS_SENT, // Post success, store unattributed unique outcome event names
+                // Post success, store unattributed unique outcome event names
+                PreferenceOneSignalKeys.PREFS_OS_UNATTRIBUTED_UNIQUE_OUTCOME_EVENTS_SENT,
                 value,
             )
         }

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/subscriptions/SubscriptionModel.kt

@@ -48,11 +48,13 @@ enum class SubscriptionStatus(val value: Int) {
     FIREBASE_FCM_ERROR_MISC_EXCEPTION(-12),
 
     // -13 to -24 reserved for other platforms
+
     /** The subscription is not enabled due the an HMS timeout, this can be retried */
     HMS_TOKEN_TIMEOUT(-25),
 
     // Most likely missing "client/app_id".
     // Check that there is "apply plugin: 'com.huawei.agconnect'" in your app/build.gradle
+
     /** The subscription is not enabled due to the HMS arguments being invalid */
     HMS_ARGUMENTS_INVALID(-26),