Bug 1975907 - Update annotation syntax for defaulting rule changes. r=android-reviewers,mcarare

warning: This annotation is currently applied to the value parameter only, but in the future it will also be applied to 'field'. See https://youtrack.jetbrains.com/issue/KT-73255 for more details. To remove this warning, use the '@param:' annotation target.

Differential Revision: https://phabricator.services.mozilla.com/D256213

Author: rvandermeulen

mobile/android/android-components/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt

@@ -102,11 +102,11 @@ object ErrorPages {
  * Enum containing all supported error types that we can display an error page for.
  */
 enum class ErrorType(
-    @StringRes val titleRes: Int,
-    @StringRes val messageRes: Int,
-    @StringRes val refreshButtonRes: Int = R.string.mozac_browser_errorpages_page_refresh,
-    @StringRes val imageNameRes: Int? = null,
-    @StringRes val errorCode: Int? = null,
+    @param:StringRes val titleRes: Int,
+    @param:StringRes val messageRes: Int,
+    @param:StringRes val refreshButtonRes: Int = R.string.mozac_browser_errorpages_page_refresh,
+    @param:StringRes val imageNameRes: Int? = null,
+    @param:StringRes val errorCode: Int? = null,
 ) {
     UNKNOWN(
         R.string.mozac_browser_errorpages_generic_title,

mobile/android/android-components/components/browser/icons/src/main/java/mozilla/components/browser/icons/IconRequest.kt

@@ -23,7 +23,7 @@ data class IconRequest(
     val url: String,
     val size: Size = Size.DEFAULT,
     val resources: List<Resource> = emptyList(),
-    @ColorInt val color: Int? = null,
+    @param:ColorInt val color: Int? = null,
     val isPrivate: Boolean = false,
     val waitOnNetworkLoad: Boolean = true,
 ) {
@@ -33,7 +33,7 @@ data class IconRequest(
      *
      * We are trying to limit the supported sizes in order to optimize our caching strategy.
      */
-    enum class Size(@DimenRes val dimen: Int) {
+    enum class Size(@param:DimenRes val dimen: Int) {
         DEFAULT(R.dimen.mozac_browser_icons_size_default),
         LAUNCHER(R.dimen.mozac_browser_icons_size_launcher),
         LAUNCHER_ADAPTIVE(R.dimen.mozac_browser_icons_size_launcher_adaptive),

mobile/android/android-components/components/browser/icons/src/main/java/mozilla/components/browser/icons/generator/DefaultIconGenerator.kt

@@ -29,9 +29,9 @@ import kotlin.math.abs
  * representing the URL.
  */
 class DefaultIconGenerator(
-    @DimenRes private val cornerRadiusDimen: Int? = R.dimen.mozac_browser_icons_generator_default_corner_radius,
-    @ColorRes private val textColorRes: Int = R.color.mozac_browser_icons_generator_default_text_color,
-    @ArrayRes private val backgroundColorsRes: Int = R.array.mozac_browser_icons_photon_palette,
+    @param:DimenRes private val cornerRadiusDimen: Int? = R.dimen.mozac_browser_icons_generator_default_corner_radius,
+    @param:ColorRes private val textColorRes: Int = R.color.mozac_browser_icons_generator_default_text_color,
+    @param:ArrayRes private val backgroundColorsRes: Int = R.array.mozac_browser_icons_photon_palette,
 ) : IconGenerator {
 
     override fun generate(context: Context, request: IconRequest): Icon {

mobile/android/android-components/components/browser/menu/src/main/java/mozilla/components/browser/menu/BrowserMenuHighlight.kt

@@ -37,7 +37,7 @@ sealed class BrowserMenuHighlight {
      * displaying their own highlight.
      */
     data class LowPriority(
-        @ColorInt val notificationTint: Int,
+        @param:ColorInt val notificationTint: Int,
         override val label: String? = null,
         override val canPropagate: Boolean = true,
     ) : BrowserMenuHighlight() {
@@ -58,7 +58,7 @@ sealed class BrowserMenuHighlight {
      * displaying their own highlight.
      */
     data class HighPriority(
-        @ColorInt val backgroundTint: Int,
+        @param:ColorInt val backgroundTint: Int,
         override val label: String? = null,
         val endImageResource: Int = NO_ID,
         override val canPropagate: Boolean = true,
@@ -79,10 +79,10 @@ sealed class BrowserMenuHighlight {
      */
     @Deprecated("Replace with LowPriority or HighPriority highlight")
     open class ClassicHighlight(
-        @DrawableRes val startImageResource: Int,
-        @DrawableRes val endImageResource: Int,
-        @DrawableRes val backgroundResource: Int,
-        @ColorRes val colorResource: Int,
+        @param:DrawableRes val startImageResource: Int,
+        @param:DrawableRes val endImageResource: Int,
+        @param:DrawableRes val backgroundResource: Int,
+        @param:ColorRes val colorResource: Int,
         override val canPropagate: Boolean = true,
     ) : BrowserMenuHighlight() {
         override val label: String? = null

mobile/android/android-components/components/browser/menu/src/main/java/mozilla/components/browser/menu/BrowserMenuPositioning.kt

@@ -39,17 +39,17 @@ internal data class MenuPositioningData(
     /**
      * Distance between [display top, anchor top margin]. Used for better positioning the menu.
      */
-    @Px val availableHeightToTop: Int = 0,
+    @param:Px val availableHeightToTop: Int = 0,
 
     /**
      * Distance between [display bottom, anchor bottom margin]. Used for better positioning the menu.
      */
-    @Px val availableHeightToBottom: Int = 0,
+    @param:Px val availableHeightToBottom: Int = 0,
 
     /**
      * [View#measuredHeight] of the menu. May be bigger than the available screen height.
      */
-    @Px val containerViewHeight: Int = 0,
+    @param:Px val containerViewHeight: Int = 0,
 )
 
 /**

mobile/android/android-components/components/browser/menu/src/main/java/mozilla/components/browser/menu/WebExtensionBrowserMenuBuilder.kt

@@ -156,11 +156,8 @@ class WebExtensionBrowserMenuBuilder(
      * Allows to customize how items should look like.
      */
     data class Style(
-        @ColorRes
-        val webExtIconTintColorResource: Int = NO_ID,
-        @DrawableRes
-        val backPressMenuItemDrawableRes: Int = iconsR.drawable.mozac_ic_back_24,
-        @DrawableRes
-        val addonsManagerMenuItemDrawableRes: Int = iconsR.drawable.mozac_ic_extension_24,
+        @param:ColorRes val webExtIconTintColorResource: Int = NO_ID,
+        @param:DrawableRes val backPressMenuItemDrawableRes: Int = iconsR.drawable.mozac_ic_back_24,
+        @param:DrawableRes val addonsManagerMenuItemDrawableRes: Int = iconsR.drawable.mozac_ic_extension_24,
     )
 }

mobile/android/android-components/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuCategory.kt

@@ -35,12 +35,10 @@ import mozilla.components.concept.menu.candidate.TypefaceStyle
 class BrowserMenuCategory(
     internal val label: String,
     private val textSize: Float = NO_ID.toFloat(),
-    @ColorRes
-    private val textColorResource: Int = NO_ID,
-    @ColorRes
-    private val backgroundColorResource: Int = NO_ID,
-    @TypefaceStyle private val textStyle: Int = Typeface.BOLD,
-    @TextAlignment private val textAlignment: Int = View.TEXT_ALIGNMENT_VIEW_START,
+    @param:ColorRes private val textColorResource: Int = NO_ID,
+    @param:ColorRes private val backgroundColorResource: Int = NO_ID,
+    @param:TypefaceStyle private val textStyle: Int = Typeface.BOLD,
+    @param:TextAlignment private val textAlignment: Int = View.TEXT_ALIGNMENT_VIEW_START,
     override val isCollapsingMenuLimit: Boolean = false,
     override val isSticky: Boolean = false,
 ) : BrowserMenuItem {

mobile/android/android-components/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuHighlightableItem.kt

@@ -41,9 +41,9 @@ private val defaultHighlight = BrowserMenuHighlightableItem.Highlight(0, 0, 0, 0
  */
 class BrowserMenuHighlightableItem(
     private val label: String,
-    @DrawableRes private val startImageResource: Int,
+    @param:DrawableRes private val startImageResource: Int,
     @ColorRes iconTintColorResource: Int = NO_ID,
-    @ColorRes private val textColorResource: Int = NO_ID,
+    @param:ColorRes private val textColorResource: Int = NO_ID,
     enabled: Boolean = true,
     override val isCollapsingMenuLimit: Boolean = false,
     override val isSticky: Boolean = false,

mobile/android/android-components/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuHighlightableSwitch.kt

@@ -32,9 +32,9 @@ import mozilla.components.concept.menu.candidate.LowPriorityHighlightEffect
  */
 class BrowserMenuHighlightableSwitch(
     label: String,
-    @DrawableRes private val startImageResource: Int,
-    @ColorRes private val iconTintColorResource: Int = NO_ID,
-    @ColorRes private val textColorResource: Int = NO_ID,
+    @param:DrawableRes private val startImageResource: Int,
+    @param:ColorRes private val iconTintColorResource: Int = NO_ID,
+    @param:ColorRes private val textColorResource: Int = NO_ID,
     override val isCollapsingMenuLimit: Boolean = false,
     override val isSticky: Boolean = false,
     override val highlight: BrowserMenuHighlight.LowPriority,

mobile/android/android-components/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuImageSwitch.kt

@@ -28,8 +28,7 @@ import java.lang.reflect.Modifier
  */
 class BrowserMenuImageSwitch(
     @get:VisibleForTesting(otherwise = Modifier.PRIVATE)
-    @DrawableRes
-    val imageResource: Int,
+    @param:DrawableRes val imageResource: Int,
     label: String,
     override val isCollapsingMenuLimit: Boolean = false,
     override val isSticky: Boolean = false,