Bug 1862658 - Fix OutdatedDocumentation errors

Behavior change from detekt/detekt#6372.

fenix/app/src/main/java/org/mozilla/fenix/FenixLogSink.kt

@@ -11,8 +11,8 @@ import mozilla.components.support.base.log.sink.LogSink
 /**
  * Fenix [LogSink] implementation that writes to Android's log, depending on settings.
  *
- * @property logsDebug If set to false, removes logging of debug logs.
- * @property androidLogSink an [AndroidLogSink] that writes to Android's log.
+ * @param logsDebug If set to false, removes logging of debug logs.
+ * @param androidLogSink an [AndroidLogSink] that writes to Android's log.
  */
 class FenixLogSink(
  private val logsDebug: Boolean = true,

fenix/app/src/main/java/org/mozilla/fenix/ServiceWorkerSupportFeature.kt

@@ -18,7 +18,7 @@ import org.mozilla.fenix.ext.components
  *
  * Will automatically register callbacks for service workers requests and cleanup when [homeActivity] is destroyed.
  *
- * @property homeActivity [HomeActivity] used for navigating to browser or accessing various app components.
+ * @param homeActivity [HomeActivity] used for navigating to browser or accessing various app components.
  */
 class ServiceWorkerSupportFeature(
  private val homeActivity: HomeActivity,

fenix/app/src/main/java/org/mozilla/fenix/browser/infobanner/DynamicInfoBanner.kt

@@ -12,7 +12,7 @@ import androidx.coordinatorlayout.widget.CoordinatorLayout
  * [InfoBanner] that will automatically scroll with the top [BrowserToolbar].
  * Only to be used with [BrowserToolbar]s placed at the top of the screen.
  *
- * @property context A [Context] for accessing system resources.
+ * @param context A [Context] for accessing system resources.
  * @param container The layout where the banner will be shown.
  * @property shouldScrollWithTopToolbar whether to follow the Y translation of the top toolbar or not.
  * @param message The message displayed in the banner.

fenix/app/src/main/java/org/mozilla/fenix/browser/infobanner/InfoBanner.kt

@@ -17,14 +17,14 @@ import org.mozilla.fenix.ext.settings
  * Displays an Info Banner in the specified container with a message and an optional action.
  * The container can be a placeholder layout inserted in the original screen, or an existing layout.
  *
- * @property context A [Context] for accessing system resources.
- * @property container The layout where the banner will be shown.
- * @property message The message displayed in the banner.
- * @property dismissText The text on the dismiss button.
- * @property actionText The text on the action to perform button.
- * @property dismissByHiding Whether or not to hide the banner when dismissed.
+ * @param context A [Context] for accessing system resources.
+ * @param container The layout where the banner will be shown.
+ * @param message The message displayed in the banner.
+ * @param dismissText The text on the dismiss button.
+ * @param actionText The text on the action to perform button.
+ * @param dismissByHiding Whether or not to hide the banner when dismissed.
  * @property dismissAction Optional callback invoked when the user dismisses the banner.
- * @property actionToPerform The action to be performed on action button press.
+ * @param actionToPerform The action to be performed on action button press.
  */
 @SuppressWarnings("LongParameterList")
 open class InfoBanner(

fenix/app/src/main/java/org/mozilla/fenix/collections/CollectionCreationController.kt

@@ -64,11 +64,11 @@ fun List<Tab>.toTabSessionStateList(store: BrowserStore): List<TabSessionState>
 }
 
 /**
- * @property store Store used to hold in-memory collection state.
- * @property browserStore The global `BrowserStore` instance.
- * @property dismiss Callback to dismiss the collection creation dialog.
- * @property tabCollectionStorage Storage used to save tab collections to disk.
- * @property scope Coroutine scope to launch coroutines.
+ * @param store Store used to hold in-memory collection state.
+ * @param browserStore The global `BrowserStore` instance.
+ * @param dismiss Callback to dismiss the collection creation dialog.
+ * @param tabCollectionStorage Storage used to save tab collections to disk.
+ * @param scope Coroutine scope to launch coroutines.
  */
 class DefaultCollectionCreationController(
  private val store: CollectionCreationStore,

fenix/app/src/main/java/org/mozilla/fenix/components/AccountAbnormalities.kt

@@ -49,7 +49,7 @@ internal abstract class AbnormalFxaEvent : Exception() {
  * See [AbnormalFxaEvent] for types of abnormal events this class detects.
  *
  * @param context An Android [Context].
- * @property crashReporter An instance of [CrashReporter] used for reporting detected abnormalities.
+ * @param crashReporter An instance of [CrashReporter] used for reporting detected abnormalities.
  * @param strictMode An instance of [StrictModeManager] used to manage strict mode settings for the
  * application.
  */

fenix/app/src/main/java/org/mozilla/fenix/components/FindInPageIntegration.kt

@@ -22,12 +22,12 @@ import org.mozilla.fenix.components.FindInPageIntegration.ToolbarInfo
 /**
  * BrowserFragment delegate to handle all layout updates needed to show or hide the find in page bar.
  *
- * @property store The [BrowserStore] used to look up the current selected tab.
- * @property sessionId ID of the [store] session in which the query will be performed.
- * @property view The [FindInPageBar] view to display.
- * @property engineView the browser in which the queries will be made and which needs to be better positioned
+ * @param store The [BrowserStore] used to look up the current selected tab.
+ * @param sessionId ID of the [store] session in which the query will be performed.
+ * @param view The [FindInPageBar] view to display.
+ * @param engineView the browser in which the queries will be made and which needs to be better positioned
  * to suit the find in page bar.
- * @property toolbarInfo [ToolbarInfo] used to configure the [BrowserToolbar] while the find in page bar is shown.
+ * @param toolbarInfo [ToolbarInfo] used to configure the [BrowserToolbar] while the find in page bar is shown.
  */
 class FindInPageIntegration(
  private val store: BrowserStore,

fenix/app/src/main/java/org/mozilla/fenix/components/StoreProvider.kt

@@ -33,7 +33,7 @@ class StoreProvider<T : Store<*, *>>(
 /**
  * ViewModel factory to create [StoreProvider] instances.
  *
- * @property createStore Callback to create a new [Store], used when the [ViewModel] is first created.
+ * @param createStore Callback to create a new [Store], used when the [ViewModel] is first created.
  */
 @VisibleForTesting
 class StoreProviderFactory<T : Store<*, *>>(

fenix/app/src/main/java/org/mozilla/fenix/components/bookmarks/BookmarksUseCase.kt

@@ -51,8 +51,8 @@ class BookmarksUseCase(
  /**
  * Uses for retrieving recently added bookmarks.
  *
- * @property bookmarksStorage [BookmarksStorage] to retrieve the bookmark data.
- * @property historyStorage Optional [HistoryStorage] to retrieve the preview image of a visited
+ * @param bookmarksStorage [BookmarksStorage] to retrieve the bookmark data.
+ * @param historyStorage Optional [HistoryStorage] to retrieve the preview image of a visited
  * page associated with a bookmark.
  */
  class RetrieveRecentBookmarksUseCase internal constructor(

fenix/app/src/main/java/org/mozilla/fenix/components/history/PagedHistoryProvider.kt

@@ -81,7 +81,7 @@ interface PagedHistoryProvider {
 }
 
 /**
- * @property historyStorage An instance [PlacesHistoryStorage] that provides read/write methods for
+ * @param historyStorage An instance [PlacesHistoryStorage] that provides read/write methods for
  * history data.
  */
 class DefaultPagedHistoryProvider(

fenix/app/src/main/java/org/mozilla/fenix/components/toolbar/BrowserMenuSignIn.kt

@@ -20,7 +20,7 @@ import org.mozilla.fenix.ext.components
  * A menu item for displaying account information. The item computes the label on every bind call,
  * to provide each menu with the latest account manager state.
  *
- * @property textColorResource ID of color resource to tint the text.
+ * @param textColorResource ID of color resource to tint the text.
  * @param imageResource ID of a drawable resource to be shown as icon.
  * @param listener Callback to be invoked when this menu item is clicked.
  */

fenix/app/src/main/java/org/mozilla/fenix/components/toolbar/BrowserToolbarCFRPresenter.kt

@@ -62,15 +62,15 @@ internal var CFR_MINIMUM_NUMBER_OPENED_TABS = 5
 /**
  * Delegate for handling all the business logic for showing CFRs in the toolbar.
  *
- * @property context used for various Android interactions.
- * @property browserStore will be observed for tabs updates
- * @property settings used to read and write persistent user settings
- * @property toolbar will serve as anchor for the CFRs
- * @property isPrivate Whether or not the session is private.
- * @property sessionId optional custom tab id used to identify the custom tab in which to show a CFR.
- * @property onShoppingCfrActionClicked Triggered when the user taps on the shopping CFR action.
- * @property onShoppingCfrDismiss Triggered when the user closes the shopping CFR using the "X" button.
- * @property shoppingExperienceFeature Used to determine if [ShoppingExperienceFeature] is enabled.
+ * @param context used for various Android interactions.
+ * @param browserStore will be observed for tabs updates
+ * @param settings used to read and write persistent user settings
+ * @param toolbar will serve as anchor for the CFRs
+ * @param isPrivate Whether or not the session is private.
+ * @param sessionId optional custom tab id used to identify the custom tab in which to show a CFR.
+ * @param onShoppingCfrActionClicked Triggered when the user taps on the shopping CFR action.
+ * @param onShoppingCfrDismiss Triggered when the user closes the shopping CFR using the "X" button.
+ * @param shoppingExperienceFeature Used to determine if [ShoppingExperienceFeature] is enabled.
  */
 @Suppress("LongParameterList")
 class BrowserToolbarCFRPresenter(

fenix/app/src/main/java/org/mozilla/fenix/components/toolbar/DefaultToolbarMenu.kt

@@ -44,13 +44,13 @@ import org.mozilla.fenix.theme.ThemeManager
 
 /**
  * Builds the toolbar object used with the 3-dot menu in the browser fragment.
- * @property context a [Context] for accessing system resources.
- * @property store reference to the application's [BrowserStore].
+ * @param context a [Context] for accessing system resources.
+ * @param store reference to the application's [BrowserStore].
  * @param hasAccountProblem If true, there was a problem signing into the Firefox account.
- * @property onItemTapped Called when a menu item is tapped.
- * @property lifecycleOwner View lifecycle owner used to determine when to cancel UI jobs.
- * @property bookmarksStorage Used to check if a page is bookmarked.
- * @property pinnedSiteStorage Used to check if the current url is a pinned site.
+ * @param onItemTapped Called when a menu item is tapped.
+ * @param lifecycleOwner View lifecycle owner used to determine when to cancel UI jobs.
+ * @param bookmarksStorage Used to check if a page is bookmarked.
+ * @param pinnedSiteStorage Used to check if the current url is a pinned site.
  * @property isPinningSupported true if the launcher supports adding shortcuts.
  */
 @Suppress("LargeClass", "LongParameterList", "TooManyFunctions")

fenix/app/src/main/java/org/mozilla/fenix/components/toolbar/interactor/BrowserToolbarInteractor.kt

@@ -53,9 +53,9 @@ interface BrowserToolbarInteractor {
 /**
  * The default implementation of [BrowserToolbarInteractor].
  *
- * @property browserToolbarController [BrowserToolbarController] to which user actions can be
+ * @param browserToolbarController [BrowserToolbarController] to which user actions can be
  * delegated for all interactions on the browser toolbar.
- * @property menuController [BrowserToolbarMenuController] to which user actions can be delegated
+ * @param menuController [BrowserToolbarMenuController] to which user actions can be delegated
  * for all interactions on the the browser toolbar menu.
  */
 class DefaultBrowserToolbarInteractor(

fenix/app/src/main/java/org/mozilla/fenix/crashes/CrashContentIntegration.kt

@@ -24,17 +24,17 @@ import org.mozilla.fenix.utils.Settings
 /**
  * Helper for observing [BrowserStore] and show an in-app crash reporter for tabs with content crashes.
  *
- * @property browserStore [BrowserStore] observed for any changes related to [EngineState.crashed].
- * @property appStore [AppStore] that tracks all content crashes in the current app session until the user
+ * @param browserStore [BrowserStore] observed for any changes related to [EngineState.crashed].
+ * @param appStore [AppStore] that tracks all content crashes in the current app session until the user
  * decides to either send or dismiss all crash reports.
- * @property toolbar [BrowserToolbar] that will be expanded when showing the in-app crash reporter.
- * @property isToolbarPlacedAtTop [Boolean] based allowing the in-app crash reporter to be shown as
+ * @param toolbar [BrowserToolbar] that will be expanded when showing the in-app crash reporter.
+ * @param isToolbarPlacedAtTop [Boolean] based allowing the in-app crash reporter to be shown as
  * immediately below or above the toolbar.
- * @property crashReporterView [CrashContentView] which will be shown if the current tab is marked as crashed.
- * @property components [Components] allowing interactions with other app features.
- * @property settings [Settings] allowing to check whether crash reporting is enabled or not.
- * @property navController [NavController] used to navigate to other parts of the app.
- * @property sessionId [String] Id of the tab or custom tab which should be observed for [EngineState.crashed]
+ * @param crashReporterView [CrashContentView] which will be shown if the current tab is marked as crashed.
+ * @param components [Components] allowing interactions with other app features.
+ * @param settings [Settings] allowing to check whether crash reporting is enabled or not.
+ * @param navController [NavController] used to navigate to other parts of the app.
+ * @param sessionId [String] Id of the tab or custom tab which should be observed for [EngineState.crashed]
  * depending on which [crashReporterView] will be shown or hidden.
  */
 

fenix/app/src/main/java/org/mozilla/fenix/customtabs/CustomTabToolbarMenu.kt

@@ -32,12 +32,12 @@ import java.util.Locale
 /**
  * Builds the toolbar object used with the 3-dot menu in the custom tab browser fragment.
  *
- * @property context An Android [Context].
- * @property store reference to the application's [BrowserStore].
- * @property sessionId ID of the open custom tab session.
- * @property shouldReverseItems If true, reverse the menu items.
- * @property isSandboxCustomTab If true, menu should not show the "Open in Firefox" and "POWERED BY FIREFOX" items.
- * @property onItemTapped Called when a menu item is tapped.
+ * @param context An Android [Context].
+ * @param store reference to the application's [BrowserStore].
+ * @param sessionId ID of the open custom tab session.
+ * @param shouldReverseItems If true, reverse the menu items.
+ * @param isSandboxCustomTab If true, menu should not show the "Open in Firefox" and "POWERED BY FIREFOX" items.
+ * @param onItemTapped Called when a menu item is tapped.
  */
 class CustomTabToolbarMenu(
  private val context: Context,

fenix/app/src/main/java/org/mozilla/fenix/downloads/StartDownloadDialog.kt

@@ -34,7 +34,7 @@ import org.mozilla.fenix.ext.settings
 /**
  * Parent of all download views that can mimic a modal [Dialog].
  *
- * @property activity The [Activity] in which the dialog will be shown.
+ * @param activity The [Activity] in which the dialog will be shown.
  * Used to update the activity [Window] to best mimic a modal dialog.
  */
 abstract class StartDownloadDialog(
@@ -153,13 +153,13 @@ abstract class StartDownloadDialog(
 /**
  * A download view mimicking a modal dialog that allows the user to download a file with the current application.
  *
- * @property activity The [Activity] in which the dialog will be shown.
+ * @param activity The [Activity] in which the dialog will be shown.
  * Used to update the activity [Window] to best mimic a modal dialog.
- * @property filename Name of the file to be downloaded. It wil be shown without any modification.
- * @property contentSize Size of the file to be downloaded expressed as a number of bytes.
+ * @param filename Name of the file to be downloaded. It wil be shown without any modification.
+ * @param contentSize Size of the file to be downloaded expressed as a number of bytes.
  * It will automatically be parsed to the appropriate kilobyte or megabyte value before being shown.
- * @property positiveButtonAction Callback for when the user interacts with the dialog to start the download.
- * @property negativeButtonAction Callback for when the user interacts with the dialog to dismiss it.
+ * @param positiveButtonAction Callback for when the user interacts with the dialog to start the download.
+ * @param negativeButtonAction Callback for when the user interacts with the dialog to dismiss it.
  */
 class FirstPartyDownloadDialog(
  private val activity: Activity,
@@ -212,11 +212,11 @@ class FirstPartyDownloadDialog(
  * A download view mimicking a modal dialog that presents the user with a list of all apps
  * that can handle the download request.
  *
- * @property activity The [Activity] in which the dialog will be shown.
+ * @param activity The [Activity] in which the dialog will be shown.
  * Used to update the activity [Window] to best mimic a modal dialog.
- * @property downloaderApps List of all applications that can handle the download request.
- * @property onAppSelected Callback for when the user chooses a specific application to handle the download request.
- * @property negativeButtonAction Callback for when the user interacts with the dialog to dismiss it.
+ * @param downloaderApps List of all applications that can handle the download request.
+ * @param onAppSelected Callback for when the user chooses a specific application to handle the download request.
+ * @param negativeButtonAction Callback for when the user interacts with the dialog to dismiss it.
  */
 class ThirdPartyDownloadDialog(
  private val activity: Activity,

fenix/app/src/main/java/org/mozilla/fenix/home/HomeMenuView.kt

@@ -36,14 +36,14 @@ import org.mozilla.fenix.GleanMetrics.HomeMenu as HomeMenuMetrics
 /**
  * Helper class for building the [HomeMenu].
  *
- * @property view The [View] to attach the snackbar to.
- * @property context An Android [Context].
- * @property lifecycleOwner [LifecycleOwner] for the view.
- * @property homeActivity [HomeActivity] used to open URLs in a new tab.
- * @property navController [NavController] used for navigation.
- * @property menuButton The [MenuButton] that will be used to create a menu when the button is
+ * @param view The [View] to attach the snackbar to.
+ * @param context An Android [Context].
+ * @param lifecycleOwner [LifecycleOwner] for the view.
+ * @param homeActivity [HomeActivity] used to open URLs in a new tab.
+ * @param navController [NavController] used for navigation.
+ * @param menuButton The [MenuButton] that will be used to create a menu when the button is
  * clicked.
- * @property fxaEntrypoint The source entry point to FxA.
+ * @param fxaEntrypoint The source entry point to FxA.
  */
 @Suppress("LongParameterList")
 class HomeMenuView(

fenix/app/src/main/java/org/mozilla/fenix/home/PocketUpdatesMiddleware.kt

@@ -29,10 +29,10 @@ import org.mozilla.fenix.home.pocket.PocketRecommendedStoriesSelectedCategory
 /**
  * [AppStore] middleware reacting in response to Pocket related [Action]s.
  *
- * @property pocketStoriesService [PocketStoriesService] used for updating details about the Pocket recommended stories.
- * @property selectedPocketCategoriesDataStore [DataStore] used for reading or persisting details about the
+ * @param pocketStoriesService [PocketStoriesService] used for updating details about the Pocket recommended stories.
+ * @param selectedPocketCategoriesDataStore [DataStore] used for reading or persisting details about the
  * currently selected Pocket recommended stories categories.
- * @property coroutineScope [CoroutineScope] used for long running operations like disk IO.
+ * @param coroutineScope [CoroutineScope] used for long running operations like disk IO.
  */
 class PocketUpdatesMiddleware(
  private val pocketStoriesService: PocketStoriesService,

fenix/app/src/main/java/org/mozilla/fenix/home/TabCounterView.kt

@@ -26,10 +26,10 @@ import org.mozilla.fenix.tabstray.Page
 /**
  * Helper class for building the [FenixTabCounterMenu].
  *
- * @property context An Android [Context].
- * @property browsingModeManager [BrowsingModeManager] used for fetching the current browsing mode.
- * @property navController [NavController] used for navigation.
- * @property tabCounter The [TabCounter] that will be setup with event handlers.
+ * @param context An Android [Context].
+ * @param browsingModeManager [BrowsingModeManager] used for fetching the current browsing mode.
+ * @param navController [NavController] used for navigation.
+ * @param tabCounter The [TabCounter] that will be setup with event handlers.
  */
 class TabCounterView(
  private val context: Context,

fenix/app/src/main/java/org/mozilla/fenix/home/blocklist/BlocklistMiddleware.kt

@@ -14,7 +14,7 @@ import org.mozilla.fenix.home.recenttabs.RecentTab
  * This [Middleware] reacts to item removals from the home screen, adding them to a blocklist.
  * Additionally, it reacts to state changes in order to filter them by the blocklist.
  *
- * @property blocklistHandler An instance of [BlocklistHandler] for interacting with the blocklist
+ * @param blocklistHandler An instance of [BlocklistHandler] for interacting with the blocklist
  * stored in shared preferences.
  */
 class BlocklistMiddleware(