From 71c3287f1c90d37414c6dae07c706bd51676590d Mon Sep 17 00:00:00 2001 From: Ryan VanderMeulen Date: Thu, 2 Nov 2023 13:41:02 -0400 Subject: [PATCH] Bug 1862658 - Fix OutdatedDocumentation errors Behavior change from https://github.com/detekt/detekt/pull/6372. --- .../java/org/mozilla/fenix/FenixLogSink.kt | 4 +- .../fenix/ServiceWorkerSupportFeature.kt | 2 +- .../browser/infobanner/DynamicInfoBanner.kt | 2 +- .../fenix/browser/infobanner/InfoBanner.kt | 14 +++---- .../CollectionCreationController.kt | 10 ++--- .../fenix/components/AccountAbnormalities.kt | 2 +- .../fenix/components/FindInPageIntegration.kt | 10 ++--- .../mozilla/fenix/components/StoreProvider.kt | 2 +- .../components/bookmarks/BookmarksUseCase.kt | 4 +- .../history/PagedHistoryProvider.kt | 2 +- .../components/toolbar/BrowserMenuSignIn.kt | 2 +- .../toolbar/BrowserToolbarCFRPresenter.kt | 18 ++++----- .../components/toolbar/DefaultToolbarMenu.kt | 12 +++--- .../interactor/BrowserToolbarInteractor.kt | 4 +- .../fenix/crashes/CrashContentIntegration.kt | 18 ++++----- .../fenix/customtabs/CustomTabToolbarMenu.kt | 12 +++--- .../fenix/downloads/StartDownloadDialog.kt | 20 +++++----- .../org/mozilla/fenix/home/HomeMenuView.kt | 14 +++---- .../fenix/home/PocketUpdatesMiddleware.kt | 6 +-- .../org/mozilla/fenix/home/TabCounterView.kt | 8 ++-- .../home/blocklist/BlocklistMiddleware.kt | 2 +- .../home/collections/CollectionViewHolder.kt | 2 +- .../collections/TabInCollectionViewHolder.kt | 2 +- .../home/pocket/PocketCategoriesViewHolder.kt | 2 +- .../PocketRecommendationsHeaderViewHolder.kt | 2 +- .../home/pocket/PocketStoriesController.kt | 4 +- .../home/pocket/PocketStoriesViewHolder.kt | 2 +- .../recentbookmarks/RecentBookmarksFeature.kt | 8 ++-- .../view/RecentBookmarksHeaderViewHolder.kt | 2 +- .../RecentSyncedTabFeature.kt | 14 +++---- .../controller/RecentSyncedTabController.kt | 8 ++-- .../view/RecentSyncedTabViewHolder.kt | 2 +- .../controller/RecentTabController.kt | 6 +-- .../recenttabs/view/RecentTabViewHolder.kt | 2 +- .../view/RecentTabsHeaderViewHolder.kt | 2 +- .../home/recentvisits/RecentVisitsFeature.kt | 10 ++--- .../view/RecentVisitsHeaderViewHolder.kt | 2 +- .../view/RecentlyVisitedViewHolder.kt | 2 +- .../home/sessioncontrol/SessionControlView.kt | 2 +- .../onboarding/MessageCardViewHolder.kt | 2 +- .../fenix/home/topsites/TopSiteItemMenu.kt | 6 +-- .../fenix/home/topsites/TopSitesViewHolder.kt | 2 +- .../bookmarks/BookmarkFragmentInteractor.kt | 2 +- .../state/HistoryNavigationMiddleware.kt | 8 ++-- .../history/state/HistoryStorageMiddleware.kt | 14 +++---- .../history/state/HistorySyncMiddleware.kt | 6 +-- .../state/HistoryTelemetryMiddleware.kt | 2 +- .../controller/NimbusBranchesController.kt | 10 ++--- .../fenix/onboarding/HomeCFRPresenter.kt | 4 +- .../search/toolbar/SearchSelectorMenu.kt | 4 +- .../toolbar/SearchSelectorToolbarAction.kt | 6 +-- .../fenix/settings/SyncPreferenceView.kt | 12 +++--- .../settings/account/DefaultSyncInteractor.kt | 2 +- .../controller/AddressEditorController.kt | 6 +-- .../controller/AddressManagementController.kt | 2 +- .../interactor/AddressEditorInteractor.kt | 2 +- .../interactor/AddressManagementInteractor.kt | 2 +- .../address/view/AddressEditorView.kt | 8 ++-- .../biometric/BiometricPromptFeature.kt | 8 ++-- .../controller/CreditCardEditorController.kt | 10 ++--- .../interactor/CreditCardEditorInteractor.kt | 2 +- .../CreditCardsManagementInteractor.kt | 2 +- .../logins/controller/LoginsListController.kt | 8 ++-- .../logins/interactor/AddLoginInteractor.kt | 2 +- .../logins/interactor/EditLoginInteractor.kt | 2 +- .../interactor/LoginDetailInteractor.kt | 2 +- .../interactor/SavedLoginsInteractor.kt | 4 +- .../quicksettings/ClearSiteDataView.kt | 2 +- .../ConnectionDetailsInteractor.kt | 2 +- .../quicksettings/ConnectionDetailsView.kt | 4 +- .../quicksettings/QuickSettingsController.kt | 22 +++++------ .../quicksettings/QuickSettingsInteractor.kt | 2 +- .../settings/quicksettings/WebsiteInfoView.kt | 4 +- .../quicksettings/WebsitePermissionsView.kt | 2 +- .../protections/ProtectionsView.kt | 2 +- .../CookieBannerDetailsInteractor.kt | 2 +- .../CookieBannerHandlingDetailsView.kt | 10 ++--- .../fenix/settings/studies/StudiesAdapter.kt | 4 +- .../fenix/share/SaveToPDFMiddleware.kt | 4 +- .../mozilla/fenix/share/ShareController.kt | 26 ++++++------- ...viewQualityCheckBottomSheetStateFeature.kt | 2 +- .../shopping/ReviewQualityCheckFeature.kt | 14 +++---- .../GetReviewQualityCheckSumoUrl.kt | 2 +- .../ReviewQualityCheckNavigationMiddleware.kt | 4 +- .../ReviewQualityCheckNetworkMiddleware.kt | 8 ++-- .../ReviewQualityCheckPreferences.kt | 2 +- ...ReviewQualityCheckPreferencesMiddleware.kt | 6 +-- .../middleware/ReviewQualityCheckService.kt | 2 +- .../ReviewQualityCheckVendorsService.kt | 2 +- .../fenix/sync/SyncedTabsIntegration.kt | 4 +- .../fenix/tabstray/TabSheetBehaviorManager.kt | 8 ++-- .../fenix/tabstray/TabsTrayController.kt | 38 +++++++++---------- .../fenix/tabstray/TabsTrayInteractor.kt | 2 +- .../browser/AbstractBrowserTabViewHolder.kt | 8 ++-- .../tabstray/browser/BrowserTabsAdapter.kt | 4 +- .../tabstray/browser/InactiveTabViewHolder.kt | 4 +- .../tabstray/browser/InactiveTabsAdapter.kt | 6 +-- .../browser/SelectionBannerBinding.kt | 14 +++---- .../browser/SelectionHandleBinding.kt | 4 +- .../fenix/tabstray/browser/TabsTouchHelper.kt | 4 +- .../compose/ComposeAbstractTabViewHolder.kt | 4 +- .../browser/compose/ComposeGridViewHolder.kt | 6 +-- .../browser/compose/ComposeListViewHolder.kt | 6 +-- .../browser/compose/ReorderableGrid.kt | 16 ++++---- .../browser/compose/ReorderableList.kt | 16 ++++---- .../syncedtabs/SyncedTabsIntegration.kt | 6 +-- .../viewholders/SyncedTabsPageViewHolder.kt | 6 +-- .../fenix/telemetry/TelemetryMiddleware.kt | 14 +++---- .../java/org/mozilla/fenix/utils/Settings.kt | 2 +- .../wallpapers/LegacyWallpaperMigration.kt | 6 +-- .../fenix/wallpapers/WallpaperDownloader.kt | 6 +-- .../fenix/wallpapers/WallpaperFileManager.kt | 4 +- .../wallpapers/WallpaperMetadataFetcher.kt | 2 +- 113 files changed, 350 insertions(+), 350 deletions(-) diff --git a/app/src/main/java/org/mozilla/fenix/FenixLogSink.kt b/app/src/main/java/org/mozilla/fenix/FenixLogSink.kt index 03f91d746..4037c0860 100644 --- a/app/src/main/java/org/mozilla/fenix/FenixLogSink.kt +++ b/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, diff --git a/app/src/main/java/org/mozilla/fenix/ServiceWorkerSupportFeature.kt b/app/src/main/java/org/mozilla/fenix/ServiceWorkerSupportFeature.kt index a1e7a922c..574d77831 100644 --- a/app/src/main/java/org/mozilla/fenix/ServiceWorkerSupportFeature.kt +++ b/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, diff --git a/app/src/main/java/org/mozilla/fenix/browser/infobanner/DynamicInfoBanner.kt b/app/src/main/java/org/mozilla/fenix/browser/infobanner/DynamicInfoBanner.kt index 41a780c41..132369dcb 100644 --- a/app/src/main/java/org/mozilla/fenix/browser/infobanner/DynamicInfoBanner.kt +++ b/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. diff --git a/app/src/main/java/org/mozilla/fenix/browser/infobanner/InfoBanner.kt b/app/src/main/java/org/mozilla/fenix/browser/infobanner/InfoBanner.kt index 377fc4a0f..1cefa8529 100644 --- a/app/src/main/java/org/mozilla/fenix/browser/infobanner/InfoBanner.kt +++ b/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( diff --git a/app/src/main/java/org/mozilla/fenix/collections/CollectionCreationController.kt b/app/src/main/java/org/mozilla/fenix/collections/CollectionCreationController.kt index 88fec6e85..76fc82868 100644 --- a/app/src/main/java/org/mozilla/fenix/collections/CollectionCreationController.kt +++ b/app/src/main/java/org/mozilla/fenix/collections/CollectionCreationController.kt @@ -64,11 +64,11 @@ fun List.toTabSessionStateList(store: BrowserStore): List } /** - * @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, diff --git a/app/src/main/java/org/mozilla/fenix/components/AccountAbnormalities.kt b/app/src/main/java/org/mozilla/fenix/components/AccountAbnormalities.kt index b46caa025..cb39ffe43 100644 --- a/app/src/main/java/org/mozilla/fenix/components/AccountAbnormalities.kt +++ b/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. */ diff --git a/app/src/main/java/org/mozilla/fenix/components/FindInPageIntegration.kt b/app/src/main/java/org/mozilla/fenix/components/FindInPageIntegration.kt index 1f7af312c..fbffa7d3b 100644 --- a/app/src/main/java/org/mozilla/fenix/components/FindInPageIntegration.kt +++ b/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, diff --git a/app/src/main/java/org/mozilla/fenix/components/StoreProvider.kt b/app/src/main/java/org/mozilla/fenix/components/StoreProvider.kt index 9508d611d..5d50957e3 100644 --- a/app/src/main/java/org/mozilla/fenix/components/StoreProvider.kt +++ b/app/src/main/java/org/mozilla/fenix/components/StoreProvider.kt @@ -33,7 +33,7 @@ class StoreProvider>( /** * 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>( diff --git a/app/src/main/java/org/mozilla/fenix/components/bookmarks/BookmarksUseCase.kt b/app/src/main/java/org/mozilla/fenix/components/bookmarks/BookmarksUseCase.kt index 500f1dd8f..19a8c856b 100644 --- a/app/src/main/java/org/mozilla/fenix/components/bookmarks/BookmarksUseCase.kt +++ b/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( diff --git a/app/src/main/java/org/mozilla/fenix/components/history/PagedHistoryProvider.kt b/app/src/main/java/org/mozilla/fenix/components/history/PagedHistoryProvider.kt index 96d28d3e2..b972ede85 100644 --- a/app/src/main/java/org/mozilla/fenix/components/history/PagedHistoryProvider.kt +++ b/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( diff --git a/app/src/main/java/org/mozilla/fenix/components/toolbar/BrowserMenuSignIn.kt b/app/src/main/java/org/mozilla/fenix/components/toolbar/BrowserMenuSignIn.kt index 375d2b3de..635fc7bcd 100644 --- a/app/src/main/java/org/mozilla/fenix/components/toolbar/BrowserMenuSignIn.kt +++ b/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. */ diff --git a/app/src/main/java/org/mozilla/fenix/components/toolbar/BrowserToolbarCFRPresenter.kt b/app/src/main/java/org/mozilla/fenix/components/toolbar/BrowserToolbarCFRPresenter.kt index ae00bb293..1f3817a92 100644 --- a/app/src/main/java/org/mozilla/fenix/components/toolbar/BrowserToolbarCFRPresenter.kt +++ b/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( diff --git a/app/src/main/java/org/mozilla/fenix/components/toolbar/DefaultToolbarMenu.kt b/app/src/main/java/org/mozilla/fenix/components/toolbar/DefaultToolbarMenu.kt index a8466c44e..ac0f788e3 100644 --- a/app/src/main/java/org/mozilla/fenix/components/toolbar/DefaultToolbarMenu.kt +++ b/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") diff --git a/app/src/main/java/org/mozilla/fenix/components/toolbar/interactor/BrowserToolbarInteractor.kt b/app/src/main/java/org/mozilla/fenix/components/toolbar/interactor/BrowserToolbarInteractor.kt index b452aea40..e1820ce78 100644 --- a/app/src/main/java/org/mozilla/fenix/components/toolbar/interactor/BrowserToolbarInteractor.kt +++ b/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( diff --git a/app/src/main/java/org/mozilla/fenix/crashes/CrashContentIntegration.kt b/app/src/main/java/org/mozilla/fenix/crashes/CrashContentIntegration.kt index d95b06e6f..c866a0476 100644 --- a/app/src/main/java/org/mozilla/fenix/crashes/CrashContentIntegration.kt +++ b/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. */ diff --git a/app/src/main/java/org/mozilla/fenix/customtabs/CustomTabToolbarMenu.kt b/app/src/main/java/org/mozilla/fenix/customtabs/CustomTabToolbarMenu.kt index 7863adc05..9a0834b13 100644 --- a/app/src/main/java/org/mozilla/fenix/customtabs/CustomTabToolbarMenu.kt +++ b/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, diff --git a/app/src/main/java/org/mozilla/fenix/downloads/StartDownloadDialog.kt b/app/src/main/java/org/mozilla/fenix/downloads/StartDownloadDialog.kt index 9c9f17155..6ed2c57fb 100644 --- a/app/src/main/java/org/mozilla/fenix/downloads/StartDownloadDialog.kt +++ b/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, diff --git a/app/src/main/java/org/mozilla/fenix/home/HomeMenuView.kt b/app/src/main/java/org/mozilla/fenix/home/HomeMenuView.kt index 836819470..e8f0c69b2 100644 --- a/app/src/main/java/org/mozilla/fenix/home/HomeMenuView.kt +++ b/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( diff --git a/app/src/main/java/org/mozilla/fenix/home/PocketUpdatesMiddleware.kt b/app/src/main/java/org/mozilla/fenix/home/PocketUpdatesMiddleware.kt index 3b7e50113..755ec4e82 100644 --- a/app/src/main/java/org/mozilla/fenix/home/PocketUpdatesMiddleware.kt +++ b/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, diff --git a/app/src/main/java/org/mozilla/fenix/home/TabCounterView.kt b/app/src/main/java/org/mozilla/fenix/home/TabCounterView.kt index a5eb2e49b..d9bd97a7d 100644 --- a/app/src/main/java/org/mozilla/fenix/home/TabCounterView.kt +++ b/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, diff --git a/app/src/main/java/org/mozilla/fenix/home/blocklist/BlocklistMiddleware.kt b/app/src/main/java/org/mozilla/fenix/home/blocklist/BlocklistMiddleware.kt index 56a5e5709..9c8928c41 100644 --- a/app/src/main/java/org/mozilla/fenix/home/blocklist/BlocklistMiddleware.kt +++ b/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( diff --git a/app/src/main/java/org/mozilla/fenix/home/collections/CollectionViewHolder.kt b/app/src/main/java/org/mozilla/fenix/home/collections/CollectionViewHolder.kt index 0846eabeb..cd70ec061 100644 --- a/app/src/main/java/org/mozilla/fenix/home/collections/CollectionViewHolder.kt +++ b/app/src/main/java/org/mozilla/fenix/home/collections/CollectionViewHolder.kt @@ -36,7 +36,7 @@ import org.mozilla.fenix.theme.FirefoxTheme * * @param composeView [ComposeView] which will be populated with Jetpack Compose UI content. * @param viewLifecycleOwner [LifecycleOwner] to which this Composable will be tied to. - * @property interactor [CollectionInteractor] callback for user interactions. + * @param interactor [CollectionInteractor] callback for user interactions. */ class CollectionViewHolder( composeView: ComposeView, diff --git a/app/src/main/java/org/mozilla/fenix/home/collections/TabInCollectionViewHolder.kt b/app/src/main/java/org/mozilla/fenix/home/collections/TabInCollectionViewHolder.kt index c14ebd0e4..fa3d12967 100644 --- a/app/src/main/java/org/mozilla/fenix/home/collections/TabInCollectionViewHolder.kt +++ b/app/src/main/java/org/mozilla/fenix/home/collections/TabInCollectionViewHolder.kt @@ -25,7 +25,7 @@ import org.mozilla.fenix.home.sessioncontrol.CollectionInteractor * * @param composeView [ComposeView] which will be populated with Jetpack Compose UI content. * @param viewLifecycleOwner [LifecycleOwner] to which this Composable will be tied to. - * @property interactor [CollectionInteractor] callback for user interactions. + * @param interactor [CollectionInteractor] callback for user interactions. */ class TabInCollectionViewHolder( composeView: ComposeView, diff --git a/app/src/main/java/org/mozilla/fenix/home/pocket/PocketCategoriesViewHolder.kt b/app/src/main/java/org/mozilla/fenix/home/pocket/PocketCategoriesViewHolder.kt index b6b895990..7ca7b47d6 100644 --- a/app/src/main/java/org/mozilla/fenix/home/pocket/PocketCategoriesViewHolder.kt +++ b/app/src/main/java/org/mozilla/fenix/home/pocket/PocketCategoriesViewHolder.kt @@ -35,7 +35,7 @@ internal const val POCKET_CATEGORIES_SELECTED_AT_A_TIME_COUNT = 8 * * @param composeView [ComposeView] which will be populated with Jetpack Compose UI content. * @param viewLifecycleOwner [LifecycleOwner] to which this Composable will be tied to. - * @property interactor [PocketStoriesInteractor] callback for user interaction. + * @param interactor [PocketStoriesInteractor] callback for user interaction. */ class PocketCategoriesViewHolder( composeView: ComposeView, diff --git a/app/src/main/java/org/mozilla/fenix/home/pocket/PocketRecommendationsHeaderViewHolder.kt b/app/src/main/java/org/mozilla/fenix/home/pocket/PocketRecommendationsHeaderViewHolder.kt index 1ee2552a6..43343622b 100644 --- a/app/src/main/java/org/mozilla/fenix/home/pocket/PocketRecommendationsHeaderViewHolder.kt +++ b/app/src/main/java/org/mozilla/fenix/home/pocket/PocketRecommendationsHeaderViewHolder.kt @@ -32,7 +32,7 @@ import org.mozilla.fenix.theme.FirefoxTheme * * @param composeView [ComposeView] which will be populated with Jetpack Compose UI content. * @param viewLifecycleOwner [LifecycleOwner] to which this Composable will be tied to. - * @property interactor [PocketStoriesInteractor] callback for user interaction. + * @param interactor [PocketStoriesInteractor] callback for user interaction. */ class PocketRecommendationsHeaderViewHolder( composeView: ComposeView, diff --git a/app/src/main/java/org/mozilla/fenix/home/pocket/PocketStoriesController.kt b/app/src/main/java/org/mozilla/fenix/home/pocket/PocketStoriesController.kt index 60e0099ae..e877ab455 100644 --- a/app/src/main/java/org/mozilla/fenix/home/pocket/PocketStoriesController.kt +++ b/app/src/main/java/org/mozilla/fenix/home/pocket/PocketStoriesController.kt @@ -68,8 +68,8 @@ interface PocketStoriesController { /** * Default behavior for handling all user interactions with the Pocket recommended stories feature. * - * @property homeActivity [HomeActivity] used to open URLs in a new tab. - * @property appStore [AppStore] from which to read the current Pocket recommendations and dispatch new actions on. + * @param homeActivity [HomeActivity] used to open URLs in a new tab. + * @param appStore [AppStore] from which to read the current Pocket recommendations and dispatch new actions on. */ internal class DefaultPocketStoriesController( private val homeActivity: HomeActivity, diff --git a/app/src/main/java/org/mozilla/fenix/home/pocket/PocketStoriesViewHolder.kt b/app/src/main/java/org/mozilla/fenix/home/pocket/PocketStoriesViewHolder.kt index bbc0595e5..760420ed5 100644 --- a/app/src/main/java/org/mozilla/fenix/home/pocket/PocketStoriesViewHolder.kt +++ b/app/src/main/java/org/mozilla/fenix/home/pocket/PocketStoriesViewHolder.kt @@ -34,7 +34,7 @@ import org.mozilla.fenix.wallpapers.WallpaperState * * @param composeView [ComposeView] which will be populated with Jetpack Compose UI content. * @param viewLifecycleOwner [LifecycleOwner] to which this Composable will be tied to. - * @property interactor [PocketStoriesInteractor] callback for user interaction. + * @param interactor [PocketStoriesInteractor] callback for user interaction. */ class PocketStoriesViewHolder( composeView: ComposeView, diff --git a/app/src/main/java/org/mozilla/fenix/home/recentbookmarks/RecentBookmarksFeature.kt b/app/src/main/java/org/mozilla/fenix/home/recentbookmarks/RecentBookmarksFeature.kt index 146ab03cb..3e7dc9d6c 100644 --- a/app/src/main/java/org/mozilla/fenix/home/recentbookmarks/RecentBookmarksFeature.kt +++ b/app/src/main/java/org/mozilla/fenix/home/recentbookmarks/RecentBookmarksFeature.kt @@ -20,11 +20,11 @@ import org.mozilla.fenix.home.HomeFragment * View-bound feature that retrieves a list of recently added [BookmarkNode]s and dispatches * updates to the [AppStore]. * - * @property appStore the [AppStore] that holds the state of the [HomeFragment]. - * @property bookmarksUseCase the [BookmarksUseCase] for retrieving the list of recently saved + * @param appStore the [AppStore] that holds the state of the [HomeFragment]. + * @param bookmarksUseCase the [BookmarksUseCase] for retrieving the list of recently saved * bookmarks from storage. - * @property scope the [CoroutineScope] used to fetch the bookmarks list - * @property ioDispatcher the [CoroutineDispatcher] for performing read/write operations. + * @param scope the [CoroutineScope] used to fetch the bookmarks list + * @param ioDispatcher the [CoroutineDispatcher] for performing read/write operations. */ class RecentBookmarksFeature( private val appStore: AppStore, diff --git a/app/src/main/java/org/mozilla/fenix/home/recentbookmarks/view/RecentBookmarksHeaderViewHolder.kt b/app/src/main/java/org/mozilla/fenix/home/recentbookmarks/view/RecentBookmarksHeaderViewHolder.kt index dcc7dbad1..210bad962 100644 --- a/app/src/main/java/org/mozilla/fenix/home/recentbookmarks/view/RecentBookmarksHeaderViewHolder.kt +++ b/app/src/main/java/org/mozilla/fenix/home/recentbookmarks/view/RecentBookmarksHeaderViewHolder.kt @@ -24,7 +24,7 @@ import org.mozilla.fenix.home.recentbookmarks.interactor.RecentBookmarksInteract * * @param composeView [ComposeView] which will be populated with Jetpack Compose UI content. * @param viewLifecycleOwner [LifecycleOwner] life cycle owner for the view. - * @property interactor [RecentBookmarksInteractor] which will have delegated to all user interactions. + * @param interactor [RecentBookmarksInteractor] which will have delegated to all user interactions. */ class RecentBookmarksHeaderViewHolder( composeView: ComposeView, diff --git a/app/src/main/java/org/mozilla/fenix/home/recentsyncedtabs/RecentSyncedTabFeature.kt b/app/src/main/java/org/mozilla/fenix/home/recentsyncedtabs/RecentSyncedTabFeature.kt index 38bab9d3c..ec33d98a5 100644 --- a/app/src/main/java/org/mozilla/fenix/home/recentsyncedtabs/RecentSyncedTabFeature.kt +++ b/app/src/main/java/org/mozilla/fenix/home/recentsyncedtabs/RecentSyncedTabFeature.kt @@ -33,13 +33,13 @@ import java.util.concurrent.TimeUnit /** * Delegate to handle layout updates and dispatch actions related to the recent synced tab. * - * @property context An Android [Context]. - * @property appStore Store to dispatch actions to when synced tabs are updated or errors encountered. - * @property syncStore Store to observe for changes to Sync and account status. - * @property storage Storage layer for synced tabs. - * @property accountManager Account manager to initiate Syncs and refresh devices. - * @property historyStorage Storage for searching history for preview image URLs matching synced tab. - * @property coroutineScope The scope to collect Sync state Flow updates in. + * @param context An Android [Context]. + * @param appStore Store to dispatch actions to when synced tabs are updated or errors encountered. + * @param syncStore Store to observe for changes to Sync and account status. + * @param storage Storage layer for synced tabs. + * @param accountManager Account manager to initiate Syncs and refresh devices. + * @param historyStorage Storage for searching history for preview image URLs matching synced tab. + * @param coroutineScope The scope to collect Sync state Flow updates in. */ @Suppress("LongParameterList") class RecentSyncedTabFeature( diff --git a/app/src/main/java/org/mozilla/fenix/home/recentsyncedtabs/controller/RecentSyncedTabController.kt b/app/src/main/java/org/mozilla/fenix/home/recentsyncedtabs/controller/RecentSyncedTabController.kt index ff23ae283..5888a59df 100644 --- a/app/src/main/java/org/mozilla/fenix/home/recentsyncedtabs/controller/RecentSyncedTabController.kt +++ b/app/src/main/java/org/mozilla/fenix/home/recentsyncedtabs/controller/RecentSyncedTabController.kt @@ -42,10 +42,10 @@ interface RecentSyncedTabController { /** * The default implementation of [RecentSyncedTabController]. * - * @property tabsUseCase Use cases to open the synced tab when clicked. - * @property navController [NavController] to navigate to synced tabs tray. - * @property accessPoint The action or screen that was used to navigate to the tabs tray. - * @property appStore The [AppStore] that holds the state of the [HomeFragment]. + * @param tabsUseCase Use cases to open the synced tab when clicked. + * @param navController [NavController] to navigate to synced tabs tray. + * @param accessPoint The action or screen that was used to navigate to the tabs tray. + * @param appStore The [AppStore] that holds the state of the [HomeFragment]. */ class DefaultRecentSyncedTabController( private val tabsUseCase: TabsUseCases, diff --git a/app/src/main/java/org/mozilla/fenix/home/recentsyncedtabs/view/RecentSyncedTabViewHolder.kt b/app/src/main/java/org/mozilla/fenix/home/recentsyncedtabs/view/RecentSyncedTabViewHolder.kt index c5707e48d..c943c637b 100644 --- a/app/src/main/java/org/mozilla/fenix/home/recentsyncedtabs/view/RecentSyncedTabViewHolder.kt +++ b/app/src/main/java/org/mozilla/fenix/home/recentsyncedtabs/view/RecentSyncedTabViewHolder.kt @@ -24,7 +24,7 @@ import org.mozilla.fenix.wallpapers.WallpaperState * * @param composeView [ComposeView] which will be populated with Jetpack Compose UI content. * @param viewLifecycleOwner [LifecycleOwner] to which this Composable will be tied to. - * @property recentSyncedTabInteractor [RecentSyncedTabInteractor] which will have delegated to all + * @param recentSyncedTabInteractor [RecentSyncedTabInteractor] which will have delegated to all * recent synced tab user interactions. */ class RecentSyncedTabViewHolder( diff --git a/app/src/main/java/org/mozilla/fenix/home/recenttabs/controller/RecentTabController.kt b/app/src/main/java/org/mozilla/fenix/home/recenttabs/controller/RecentTabController.kt index 20ba217cd..ae052e1c0 100644 --- a/app/src/main/java/org/mozilla/fenix/home/recenttabs/controller/RecentTabController.kt +++ b/app/src/main/java/org/mozilla/fenix/home/recenttabs/controller/RecentTabController.kt @@ -40,9 +40,9 @@ interface RecentTabController { /** * The default implementation of [RecentTabController]. * - * @property selectTabUseCase [SelectTabUseCase] used selecting a tab. - * @property navController [NavController] used for navigation. - * @property appStore The [AppStore] that holds the state of the [HomeFragment]. + * @param selectTabUseCase [SelectTabUseCase] used selecting a tab. + * @param navController [NavController] used for navigation. + * @param appStore The [AppStore] that holds the state of the [HomeFragment]. */ class DefaultRecentTabsController( private val selectTabUseCase: SelectTabUseCase, diff --git a/app/src/main/java/org/mozilla/fenix/home/recenttabs/view/RecentTabViewHolder.kt b/app/src/main/java/org/mozilla/fenix/home/recenttabs/view/RecentTabViewHolder.kt index 6426fb439..c745cd96e 100644 --- a/app/src/main/java/org/mozilla/fenix/home/recenttabs/view/RecentTabViewHolder.kt +++ b/app/src/main/java/org/mozilla/fenix/home/recenttabs/view/RecentTabViewHolder.kt @@ -21,7 +21,7 @@ import org.mozilla.fenix.wallpapers.WallpaperState * * @param composeView [ComposeView] which will be populated with Jetpack Compose UI content. * @param viewLifecycleOwner [LifecycleOwner] to which this Composable will be tied to. - * @property recentTabInteractor [RecentTabInteractor] which will have delegated to all user recent + * @param recentTabInteractor [RecentTabInteractor] which will have delegated to all user recent * tab interactions. */ class RecentTabViewHolder( diff --git a/app/src/main/java/org/mozilla/fenix/home/recenttabs/view/RecentTabsHeaderViewHolder.kt b/app/src/main/java/org/mozilla/fenix/home/recenttabs/view/RecentTabsHeaderViewHolder.kt index 80f4d2fc2..fe6038ef9 100644 --- a/app/src/main/java/org/mozilla/fenix/home/recenttabs/view/RecentTabsHeaderViewHolder.kt +++ b/app/src/main/java/org/mozilla/fenix/home/recenttabs/view/RecentTabsHeaderViewHolder.kt @@ -24,7 +24,7 @@ import org.mozilla.fenix.home.recenttabs.interactor.RecentTabInteractor * * @param composeView [ComposeView] which will be populated with Jetpack Compose UI content. * @param viewLifecycleOwner [LifecycleOwner] to which this Composable will be tied to. - * @property interactor [RecentTabInteractor] which will have delegated to all user interactions. + * @param interactor [RecentTabInteractor] which will have delegated to all user interactions. */ class RecentTabsHeaderViewHolder( composeView: ComposeView, diff --git a/app/src/main/java/org/mozilla/fenix/home/recentvisits/RecentVisitsFeature.kt b/app/src/main/java/org/mozilla/fenix/home/recentvisits/RecentVisitsFeature.kt index 3c0a3cb2b..f1bdcd008 100644 --- a/app/src/main/java/org/mozilla/fenix/home/recentvisits/RecentVisitsFeature.kt +++ b/app/src/main/java/org/mozilla/fenix/home/recentvisits/RecentVisitsFeature.kt @@ -38,12 +38,12 @@ import kotlin.math.max * which will be mapped to [RecentlyVisitedItem]s and then dispatched to [AppStore] * to be displayed on the home screen. * - * @property appStore The [AppStore] that holds the state of the [HomeFragment]. - * @property historyMetadataStorage The storage that manages [HistoryMetadata]. - * @property historyHighlightsStorage The storage that manages [PlacesHistoryStorage]. - * @property scope The [CoroutineScope] used for IO operations related to querying history + * @param appStore The [AppStore] that holds the state of the [HomeFragment]. + * @param historyMetadataStorage The storage that manages [HistoryMetadata]. + * @param historyHighlightsStorage The storage that manages [PlacesHistoryStorage]. + * @param scope The [CoroutineScope] used for IO operations related to querying history * and then for dispatching updates. - * @property ioDispatcher The [CoroutineDispatcher] for performing read/write operations. + * @param ioDispatcher The [CoroutineDispatcher] for performing read/write operations. */ class RecentVisitsFeature( private val appStore: AppStore, diff --git a/app/src/main/java/org/mozilla/fenix/home/recentvisits/view/RecentVisitsHeaderViewHolder.kt b/app/src/main/java/org/mozilla/fenix/home/recentvisits/view/RecentVisitsHeaderViewHolder.kt index 9ec290eff..f61acc317 100644 --- a/app/src/main/java/org/mozilla/fenix/home/recentvisits/view/RecentVisitsHeaderViewHolder.kt +++ b/app/src/main/java/org/mozilla/fenix/home/recentvisits/view/RecentVisitsHeaderViewHolder.kt @@ -24,7 +24,7 @@ import org.mozilla.fenix.home.recentvisits.interactor.RecentVisitsInteractor * * @param composeView [ComposeView] which will be populated with Jetpack Compose UI content. * @param viewLifecycleOwner [LifecycleOwner] to which this Composable will be tied to. - * @property interactor [RecentVisitsInteractor] which will have delegated to all user + * @param interactor [RecentVisitsInteractor] which will have delegated to all user * interactions. */ class RecentVisitsHeaderViewHolder( diff --git a/app/src/main/java/org/mozilla/fenix/home/recentvisits/view/RecentlyVisitedViewHolder.kt b/app/src/main/java/org/mozilla/fenix/home/recentvisits/view/RecentlyVisitedViewHolder.kt index 29b82f869..14e2b02e0 100644 --- a/app/src/main/java/org/mozilla/fenix/home/recentvisits/view/RecentlyVisitedViewHolder.kt +++ b/app/src/main/java/org/mozilla/fenix/home/recentvisits/view/RecentlyVisitedViewHolder.kt @@ -27,7 +27,7 @@ import org.mozilla.fenix.wallpapers.WallpaperState * * @param composeView [ComposeView] which will be populated with Jetpack Compose UI content. * @param viewLifecycleOwner [LifecycleOwner] to which this Composable will be tied to. - * @property interactor [RecentVisitsInteractor] which will have delegated to all user interactions. + * @param interactor [RecentVisitsInteractor] which will have delegated to all user interactions. */ class RecentlyVisitedViewHolder( composeView: ComposeView, diff --git a/app/src/main/java/org/mozilla/fenix/home/sessioncontrol/SessionControlView.kt b/app/src/main/java/org/mozilla/fenix/home/sessioncontrol/SessionControlView.kt index 20ae62b92..da17a8b19 100644 --- a/app/src/main/java/org/mozilla/fenix/home/sessioncontrol/SessionControlView.kt +++ b/app/src/main/java/org/mozilla/fenix/home/sessioncontrol/SessionControlView.kt @@ -158,7 +158,7 @@ private fun collectionTabItems(collection: TabCollection) = * * @param containerView The [View] that is used to initialize the Home recycler view. * @param viewLifecycleOwner [LifecycleOwner] for the view. - * @property interactor [SessionControlInteractor] which will have delegated to all user + * @param interactor [SessionControlInteractor] which will have delegated to all user * interactions. */ class SessionControlView( diff --git a/app/src/main/java/org/mozilla/fenix/home/sessioncontrol/viewholders/onboarding/MessageCardViewHolder.kt b/app/src/main/java/org/mozilla/fenix/home/sessioncontrol/viewholders/onboarding/MessageCardViewHolder.kt index 236e65ec2..7fbe7e145 100644 --- a/app/src/main/java/org/mozilla/fenix/home/sessioncontrol/viewholders/onboarding/MessageCardViewHolder.kt +++ b/app/src/main/java/org/mozilla/fenix/home/sessioncontrol/viewholders/onboarding/MessageCardViewHolder.kt @@ -29,7 +29,7 @@ import org.mozilla.fenix.wallpapers.WallpaperState * * @param composeView [ComposeView] which will be populated with Jetpack Compose UI content. * @param viewLifecycleOwner [LifecycleOwner] to which this Composable will be tied to. - * @property interactor [SessionControlInteractor] which will have delegated to all user + * @param interactor [SessionControlInteractor] which will have delegated to all user * interactions. */ class MessageCardViewHolder( diff --git a/app/src/main/java/org/mozilla/fenix/home/topsites/TopSiteItemMenu.kt b/app/src/main/java/org/mozilla/fenix/home/topsites/TopSiteItemMenu.kt index 6fbdcaa9e..3826da5c6 100644 --- a/app/src/main/java/org/mozilla/fenix/home/topsites/TopSiteItemMenu.kt +++ b/app/src/main/java/org/mozilla/fenix/home/topsites/TopSiteItemMenu.kt @@ -13,9 +13,9 @@ import org.mozilla.fenix.R /** * Helper class for building a context menu for a top site item. * - * @property context An Android context. - * @property topSite The [TopSite] to show the context menu for. - * @property onItemTapped Callback invoked when the user taps on a menu item. + * @param context An Android context. + * @param topSite The [TopSite] to show the context menu for. + * @param onItemTapped Callback invoked when the user taps on a menu item. */ class TopSiteItemMenu( private val context: Context, diff --git a/app/src/main/java/org/mozilla/fenix/home/topsites/TopSitesViewHolder.kt b/app/src/main/java/org/mozilla/fenix/home/topsites/TopSitesViewHolder.kt index dda86f3d9..0e6eb91a1 100644 --- a/app/src/main/java/org/mozilla/fenix/home/topsites/TopSitesViewHolder.kt +++ b/app/src/main/java/org/mozilla/fenix/home/topsites/TopSitesViewHolder.kt @@ -21,7 +21,7 @@ import org.mozilla.fenix.wallpapers.WallpaperState * * @param composeView [ComposeView] which will be populated with Jetpack Compose UI content. * @param viewLifecycleOwner [LifecycleOwner] to which this Composable will be tied to. - * @property interactor [TopSiteInteractor] which will have delegated to all user top sites + * @param interactor [TopSiteInteractor] which will have delegated to all user top sites * interactions. */ class TopSitesViewHolder( diff --git a/app/src/main/java/org/mozilla/fenix/library/bookmarks/BookmarkFragmentInteractor.kt b/app/src/main/java/org/mozilla/fenix/library/bookmarks/BookmarkFragmentInteractor.kt index a3e7e4389..4cf844495 100644 --- a/app/src/main/java/org/mozilla/fenix/library/bookmarks/BookmarkFragmentInteractor.kt +++ b/app/src/main/java/org/mozilla/fenix/library/bookmarks/BookmarkFragmentInteractor.kt @@ -15,7 +15,7 @@ import org.mozilla.fenix.components.metrics.MetricsUtils * Interactor for the Bookmarks screen. * Provides implementations for the BookmarkViewInteractor. * - * @property bookmarksController view controller + * @param bookmarksController view controller */ @SuppressWarnings("TooManyFunctions") class BookmarkFragmentInteractor( diff --git a/app/src/main/java/org/mozilla/fenix/library/history/state/HistoryNavigationMiddleware.kt b/app/src/main/java/org/mozilla/fenix/library/history/state/HistoryNavigationMiddleware.kt index 59c5a24e0..4a3b57eb2 100644 --- a/app/src/main/java/org/mozilla/fenix/library/history/state/HistoryNavigationMiddleware.kt +++ b/app/src/main/java/org/mozilla/fenix/library/history/state/HistoryNavigationMiddleware.kt @@ -23,10 +23,10 @@ import org.mozilla.fenix.library.history.HistoryFragmentStore * A [Middleware] for initiating navigation events based on [HistoryFragmentAction]s that are * dispatched to the [HistoryFragmentStore]. * - * @property navController [NavController] for handling navigation events - * @property openToBrowser Callback to open history items in a browser window. - * @property onBackPressed Callback to handle back press actions. - * @property scope [CoroutineScope] used to launch coroutines. + * @param navController [NavController] for handling navigation events + * @param openToBrowser Callback to open history items in a browser window. + * @param onBackPressed Callback to handle back press actions. + * @param scope [CoroutineScope] used to launch coroutines. */ class HistoryNavigationMiddleware( private val navController: NavController, diff --git a/app/src/main/java/org/mozilla/fenix/library/history/state/HistoryStorageMiddleware.kt b/app/src/main/java/org/mozilla/fenix/library/history/state/HistoryStorageMiddleware.kt index 204e69ae4..0826558cd 100644 --- a/app/src/main/java/org/mozilla/fenix/library/history/state/HistoryStorageMiddleware.kt +++ b/app/src/main/java/org/mozilla/fenix/library/history/state/HistoryStorageMiddleware.kt @@ -28,14 +28,14 @@ import org.mozilla.fenix.library.history.toPendingDeletionHistory * A [Middleware] for initiating storage side-effects based on [HistoryFragmentAction]s that are * dispatched to the [HistoryFragmentStore]. * - * @property appStore To dispatch Actions to update global state. - * @property browserStore To dispatch Actions to update global state. - * @property historyProvider To update storage as a result of some Actions. - * @property historyStorage To update storage as a result of some Actions. - * @property undoDeleteSnackbar Called when items are deleted to offer opportunity of undoing before + * @param appStore To dispatch Actions to update global state. + * @param browserStore To dispatch Actions to update global state. + * @param historyProvider To update storage as a result of some Actions. + * @param historyStorage To update storage as a result of some Actions. + * @param undoDeleteSnackbar Called when items are deleted to offer opportunity of undoing before * deletion is fully completed. - * @property onTimeFrameDeleted Called when a time range of items is successfully deleted. - * @property scope CoroutineScope to launch storage operations into. + * @param onTimeFrameDeleted Called when a time range of items is successfully deleted. + * @param scope CoroutineScope to launch storage operations into. */ class HistoryStorageMiddleware( private val appStore: AppStore, diff --git a/app/src/main/java/org/mozilla/fenix/library/history/state/HistorySyncMiddleware.kt b/app/src/main/java/org/mozilla/fenix/library/history/state/HistorySyncMiddleware.kt index 775bb8161..ddea16594 100644 --- a/app/src/main/java/org/mozilla/fenix/library/history/state/HistorySyncMiddleware.kt +++ b/app/src/main/java/org/mozilla/fenix/library/history/state/HistorySyncMiddleware.kt @@ -18,9 +18,9 @@ import org.mozilla.fenix.library.history.HistoryFragmentState * A [Middleware] for handling Sync side-effects based on [HistoryFragmentAction]s that are dispatched * to the [HistoryFragmentStore]. * - * @property accountManager The [FxaAccountManager] for handling Sync operations. - * @property refreshView Callback to refresh the view once a Sync is completed. - * @property scope Coroutine scope to launch Sync operations into. + * @param accountManager The [FxaAccountManager] for handling Sync operations. + * @param refreshView Callback to refresh the view once a Sync is completed. + * @param scope Coroutine scope to launch Sync operations into. */ class HistorySyncMiddleware( private val accountManager: FxaAccountManager, diff --git a/app/src/main/java/org/mozilla/fenix/library/history/state/HistoryTelemetryMiddleware.kt b/app/src/main/java/org/mozilla/fenix/library/history/state/HistoryTelemetryMiddleware.kt index 3d4f4fe91..4590f4d72 100644 --- a/app/src/main/java/org/mozilla/fenix/library/history/state/HistoryTelemetryMiddleware.kt +++ b/app/src/main/java/org/mozilla/fenix/library/history/state/HistoryTelemetryMiddleware.kt @@ -18,7 +18,7 @@ import org.mozilla.fenix.GleanMetrics.History as GleanHistory * A [Middleware] for recording telemetry based on [HistoryFragmentAction]s that are dispatched to * the [HistoryFragmentStore]. * - * @property isInPrivateMode Whether the app is currently in private browsing mode. + * @param isInPrivateMode Whether the app is currently in private browsing mode. */ class HistoryTelemetryMiddleware( private val isInPrivateMode: Boolean, diff --git a/app/src/main/java/org/mozilla/fenix/nimbus/controller/NimbusBranchesController.kt b/app/src/main/java/org/mozilla/fenix/nimbus/controller/NimbusBranchesController.kt index f907446d4..1e8544260 100644 --- a/app/src/main/java/org/mozilla/fenix/nimbus/controller/NimbusBranchesController.kt +++ b/app/src/main/java/org/mozilla/fenix/nimbus/controller/NimbusBranchesController.kt @@ -24,12 +24,12 @@ import org.mozilla.fenix.nimbus.NimbusBranchesStore * [NimbusBranchesFragment] controller. This implements [NimbusBranchesAdapterDelegate] to handle * interactions with a Nimbus branch. * - * @property context An Android [Context]. - * @property navController [NavController] used for navigation. - * @property nimbusBranchesStore An instance of [NimbusBranchesStore] for dispatching + * @param context An Android [Context]. + * @param navController [NavController] used for navigation. + * @param nimbusBranchesStore An instance of [NimbusBranchesStore] for dispatching * [NimbusBranchesAction]s. - * @property experiments An instance of [NimbusApi] for interacting with the Nimbus experiments. - * @property experimentId The string experiment-id or "slug" for a Nimbus experiment. + * @param experiments An instance of [NimbusApi] for interacting with the Nimbus experiments. + * @param experimentId The string experiment-id or "slug" for a Nimbus experiment. */ class NimbusBranchesController( private val context: Context, diff --git a/app/src/main/java/org/mozilla/fenix/onboarding/HomeCFRPresenter.kt b/app/src/main/java/org/mozilla/fenix/onboarding/HomeCFRPresenter.kt index e8d0c84ac..e4f54f870 100644 --- a/app/src/main/java/org/mozilla/fenix/onboarding/HomeCFRPresenter.kt +++ b/app/src/main/java/org/mozilla/fenix/onboarding/HomeCFRPresenter.kt @@ -34,8 +34,8 @@ private const val CFR_TO_ANCHOR_VERTICAL_PADDING = -16 /** * Delegate for handling the Home Onboarding CFR. * - * @property context [Context] used for various Android interactions. - * @property recyclerView [RecyclerView] will serve as anchor for the CFR. + * @param context [Context] used for various Android interactions. + * @param recyclerView [RecyclerView] will serve as anchor for the CFR. */ class HomeCFRPresenter( private val context: Context, diff --git a/app/src/main/java/org/mozilla/fenix/search/toolbar/SearchSelectorMenu.kt b/app/src/main/java/org/mozilla/fenix/search/toolbar/SearchSelectorMenu.kt index b7a212960..9963f0024 100644 --- a/app/src/main/java/org/mozilla/fenix/search/toolbar/SearchSelectorMenu.kt +++ b/app/src/main/java/org/mozilla/fenix/search/toolbar/SearchSelectorMenu.kt @@ -23,8 +23,8 @@ typealias MozSearchEngine = SearchEngine /** * A popup menu composed of [SearchSelectorMenu.Item] objects. * - * @property context [Context] used for various Android interactions. - * @property interactor [ToolbarInteractor] for handling menu item interactions. + * @param context [Context] used for various Android interactions. + * @param interactor [ToolbarInteractor] for handling menu item interactions. */ class SearchSelectorMenu( private val context: Context, diff --git a/app/src/main/java/org/mozilla/fenix/search/toolbar/SearchSelectorToolbarAction.kt b/app/src/main/java/org/mozilla/fenix/search/toolbar/SearchSelectorToolbarAction.kt index 9aad9aaa2..d67af72a0 100644 --- a/app/src/main/java/org/mozilla/fenix/search/toolbar/SearchSelectorToolbarAction.kt +++ b/app/src/main/java/org/mozilla/fenix/search/toolbar/SearchSelectorToolbarAction.kt @@ -31,9 +31,9 @@ import org.mozilla.fenix.search.SearchDialogFragmentStore /** * A [Toolbar.Action] implementation that shows a [SearchSelector]. * - * @property store [SearchDialogFragmentStore] containing the complete state of the search dialog. - * @property defaultSearchEngine The user selected or default [SearchEngine]. - * @property menu An instance of [SearchSelectorMenu] to display a popup menu for the search + * @param store [SearchDialogFragmentStore] containing the complete state of the search dialog. + * @param defaultSearchEngine The user selected or default [SearchEngine]. + * @param menu An instance of [SearchSelectorMenu] to display a popup menu for the search * selections. */ class SearchSelectorToolbarAction( diff --git a/app/src/main/java/org/mozilla/fenix/settings/SyncPreferenceView.kt b/app/src/main/java/org/mozilla/fenix/settings/SyncPreferenceView.kt index 969726d03..f88973c02 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/SyncPreferenceView.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/SyncPreferenceView.kt @@ -20,14 +20,14 @@ import mozilla.components.service.fxa.manager.SyncEnginesStorage * that manages the sync account authentication. A toggle will be also added * depending on the sync account status. * - * @property syncPreference The sync [SyncPreference] to update and handle navigation. + * @param syncPreference The sync [SyncPreference] to update and handle navigation. * @param lifecycleOwner View lifecycle owner used to determine when to cancel UI jobs. * @param accountManager An instance of [FxaAccountManager]. - * @property syncEngine The sync engine that will be used for the sync status lookup. - * @property loggedOffTitle Text label for the setting when user is not logged in. - * @property loggedInTitle Text label for the setting when user is logged in. - * @property onSyncSignInClicked A callback executed when the sync sign in [syncPreference] is clicked. - * @property onReconnectClicked A callback executed when the [syncPreference] is clicked with a + * @param syncEngine The sync engine that will be used for the sync status lookup. + * @param loggedOffTitle Text label for the setting when user is not logged in. + * @param loggedInTitle Text label for the setting when user is logged in. + * @param onSyncSignInClicked A callback executed when the sync sign in [syncPreference] is clicked. + * @param onReconnectClicked A callback executed when the [syncPreference] is clicked with a * preference status of "Reconnect". */ @Suppress("LongParameterList") diff --git a/app/src/main/java/org/mozilla/fenix/settings/account/DefaultSyncInteractor.kt b/app/src/main/java/org/mozilla/fenix/settings/account/DefaultSyncInteractor.kt index ba6067ba1..1b92682ed 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/account/DefaultSyncInteractor.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/account/DefaultSyncInteractor.kt @@ -11,7 +11,7 @@ interface SyncInteractor { /** * Interactor for [TurnOnSyncFragment]. * - * @property syncController Handles the interactions + * @param syncController Handles the interactions */ class DefaultSyncInteractor(private val syncController: DefaultSyncController) : SyncInteractor { override fun onCameraPermissionsNeeded() { diff --git a/app/src/main/java/org/mozilla/fenix/settings/address/controller/AddressEditorController.kt b/app/src/main/java/org/mozilla/fenix/settings/address/controller/AddressEditorController.kt index d1fa4114c..5ee2ea230 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/address/controller/AddressEditorController.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/address/controller/AddressEditorController.kt @@ -43,10 +43,10 @@ interface AddressEditorController { /** * The default implementation of [AddressEditorController]. * - * @property storage An instance of the [AutofillCreditCardsAddressesStorage] for adding and retrieving + * @param storage An instance of the [AutofillCreditCardsAddressesStorage] for adding and retrieving * addresses. - * @property lifecycleScope [CoroutineScope] scope to launch coroutines. - * @property navController [NavController] used for navigation. + * @param lifecycleScope [CoroutineScope] scope to launch coroutines. + * @param navController [NavController] used for navigation. */ class DefaultAddressEditorController( private val storage: AutofillCreditCardsAddressesStorage, diff --git a/app/src/main/java/org/mozilla/fenix/settings/address/controller/AddressManagementController.kt b/app/src/main/java/org/mozilla/fenix/settings/address/controller/AddressManagementController.kt index aa9595059..aaf77306e 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/address/controller/AddressManagementController.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/address/controller/AddressManagementController.kt @@ -30,7 +30,7 @@ interface AddressManagementController { /** * The default implementation of [AddressManagementController]. * - * @property navController [NavController] used for navigation. + * @param navController [NavController] used for navigation. */ class DefaultAddressManagementController( private val navController: NavController, diff --git a/app/src/main/java/org/mozilla/fenix/settings/address/interactor/AddressEditorInteractor.kt b/app/src/main/java/org/mozilla/fenix/settings/address/interactor/AddressEditorInteractor.kt index 287d2068e..4009c2678 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/address/interactor/AddressEditorInteractor.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/address/interactor/AddressEditorInteractor.kt @@ -48,7 +48,7 @@ interface AddressEditorInteractor { /** * The default implementation of [AddressEditorInteractor]. * - * @property controller An instance of [AddressEditorController] which will be delegated for all + * @param controller An instance of [AddressEditorController] which will be delegated for all * user interactions. */ class DefaultAddressEditorInteractor( diff --git a/app/src/main/java/org/mozilla/fenix/settings/address/interactor/AddressManagementInteractor.kt b/app/src/main/java/org/mozilla/fenix/settings/address/interactor/AddressManagementInteractor.kt index 24329887e..629eaf226 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/address/interactor/AddressManagementInteractor.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/address/interactor/AddressManagementInteractor.kt @@ -30,7 +30,7 @@ interface AddressManagementInteractor { /** * The default implementation of [AddressManagementInteractor]. * - * @property controller An instance of [AddressManagementController] which will be delegated for + * @param controller An instance of [AddressManagementController] which will be delegated for * all user interactions. */ class DefaultAddressManagementInteractor( diff --git a/app/src/main/java/org/mozilla/fenix/settings/address/view/AddressEditorView.kt b/app/src/main/java/org/mozilla/fenix/settings/address/view/AddressEditorView.kt index 43a1c2457..18858e0ce 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/address/view/AddressEditorView.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/address/view/AddressEditorView.kt @@ -31,10 +31,10 @@ import org.mozilla.fenix.settings.address.toCountryCode /** * An address editor for adding or updating an address. * - * @property binding The binding used to display the view. - * @property interactor [AddressEditorInteractor] used to respond to any user interactions. - * @property region If the [RegionState] is available, it will be used to set the country when adding a new address. - * @property address An [Address] to edit. + * @param binding The binding used to display the view. + * @param interactor [AddressEditorInteractor] used to respond to any user interactions. + * @param region If the [RegionState] is available, it will be used to set the country when adding a new address. + * @param address An [Address] to edit. */ class AddressEditorView( private val binding: FragmentAddressEditorBinding, diff --git a/app/src/main/java/org/mozilla/fenix/settings/biometric/BiometricPromptFeature.kt b/app/src/main/java/org/mozilla/fenix/settings/biometric/BiometricPromptFeature.kt index f56296faa..390298927 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/biometric/BiometricPromptFeature.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/biometric/BiometricPromptFeature.kt @@ -22,10 +22,10 @@ import org.mozilla.fenix.settings.biometric.ext.isHardwareAvailable /** * A [LifecycleAwareFeature] for the Android Biometric API to prompt for user authentication. * - * @property context Android context. - * @property fragment The fragment on which this feature will live. - * @property onAuthFailure A failure callback if authentication failed. - * @property onAuthSuccess A success callback. + * @param context Android context. + * @param fragment The fragment on which this feature will live. + * @param onAuthFailure A failure callback if authentication failed. + * @param onAuthSuccess A success callback. */ class BiometricPromptFeature( private val context: Context, diff --git a/app/src/main/java/org/mozilla/fenix/settings/creditcards/controller/CreditCardEditorController.kt b/app/src/main/java/org/mozilla/fenix/settings/creditcards/controller/CreditCardEditorController.kt index 17eb91348..8a1bb8e76 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/creditcards/controller/CreditCardEditorController.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/creditcards/controller/CreditCardEditorController.kt @@ -48,12 +48,12 @@ interface CreditCardEditorController { /** * The default implementation of [CreditCardEditorController]. * - * @property storage An instance of the [AutofillCreditCardsAddressesStorage] for adding and retrieving + * @param storage An instance of the [AutofillCreditCardsAddressesStorage] for adding and retrieving * credit cards. - * @property lifecycleScope [CoroutineScope] scope to launch coroutines. - * @property navController [NavController] used for navigation. - * @property ioDispatcher [CoroutineDispatcher] used for executing async tasks. Defaults to [Dispatchers.IO]. - * @property showDeleteDialog [DialogInterface.OnClickListener] used to display a confirmation dialog + * @param lifecycleScope [CoroutineScope] scope to launch coroutines. + * @param navController [NavController] used for navigation. + * @param ioDispatcher [CoroutineDispatcher] used for executing async tasks. Defaults to [Dispatchers.IO]. + * @param showDeleteDialog [DialogInterface.OnClickListener] used to display a confirmation dialog * before removing credit card. */ class DefaultCreditCardEditorController( diff --git a/app/src/main/java/org/mozilla/fenix/settings/creditcards/interactor/CreditCardEditorInteractor.kt b/app/src/main/java/org/mozilla/fenix/settings/creditcards/interactor/CreditCardEditorInteractor.kt index cb9480a50..c4525df14 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/creditcards/interactor/CreditCardEditorInteractor.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/creditcards/interactor/CreditCardEditorInteractor.kt @@ -48,7 +48,7 @@ interface CreditCardEditorInteractor { /** * The default implementation of [CreditCardEditorInteractor]. * - * @property controller An instance of [CreditCardEditorController] which will be delegated for all + * @param controller An instance of [CreditCardEditorController] which will be delegated for all * user interactions. */ class DefaultCreditCardEditorInteractor( diff --git a/app/src/main/java/org/mozilla/fenix/settings/creditcards/interactor/CreditCardsManagementInteractor.kt b/app/src/main/java/org/mozilla/fenix/settings/creditcards/interactor/CreditCardsManagementInteractor.kt index d2da3d4ed..535a9a0dd 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/creditcards/interactor/CreditCardsManagementInteractor.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/creditcards/interactor/CreditCardsManagementInteractor.kt @@ -32,7 +32,7 @@ interface CreditCardsManagementInteractor { /** * The default implementation of [CreditCardsManagementInteractor]. * - * @property controller An instance of [CreditCardsManagementController] which will be delegated for + * @param controller An instance of [CreditCardsManagementController] which will be delegated for * all user interactions. */ class DefaultCreditCardsManagementInteractor( diff --git a/app/src/main/java/org/mozilla/fenix/settings/logins/controller/LoginsListController.kt b/app/src/main/java/org/mozilla/fenix/settings/logins/controller/LoginsListController.kt index 6abaf9bb6..2208e08e2 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/logins/controller/LoginsListController.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/logins/controller/LoginsListController.kt @@ -19,10 +19,10 @@ import org.mozilla.fenix.utils.Settings /** * Controller for the saved logins list * - * @property loginsFragmentStore Store used to hold in-memory collection state. - * @property navController NavController manages app navigation within a NavHost. - * @property browserNavigator Controller allowing browser navigation to any Uri. - * @property settings SharedPreferences wrapper for easier usage. + * @param loginsFragmentStore Store used to hold in-memory collection state. + * @param navController NavController manages app navigation within a NavHost. + * @param browserNavigator Controller allowing browser navigation to any Uri. + * @param settings SharedPreferences wrapper for easier usage. */ class LoginsListController( private val loginsFragmentStore: LoginsFragmentStore, diff --git a/app/src/main/java/org/mozilla/fenix/settings/logins/interactor/AddLoginInteractor.kt b/app/src/main/java/org/mozilla/fenix/settings/logins/interactor/AddLoginInteractor.kt index 75729028b..48240f36f 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/logins/interactor/AddLoginInteractor.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/logins/interactor/AddLoginInteractor.kt @@ -9,7 +9,7 @@ import org.mozilla.fenix.settings.logins.controller.SavedLoginsStorageController /** * Interactor for the add login screen * - * @property savedLoginsController controller for the saved logins storage + * @param savedLoginsController controller for the saved logins storage */ class AddLoginInteractor( private val savedLoginsController: SavedLoginsStorageController, diff --git a/app/src/main/java/org/mozilla/fenix/settings/logins/interactor/EditLoginInteractor.kt b/app/src/main/java/org/mozilla/fenix/settings/logins/interactor/EditLoginInteractor.kt index cb0b7a0a8..1d031c853 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/logins/interactor/EditLoginInteractor.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/logins/interactor/EditLoginInteractor.kt @@ -9,7 +9,7 @@ import org.mozilla.fenix.settings.logins.controller.SavedLoginsStorageController /** * Interactor for the edit login screen * - * @property savedLoginsController controller for the saved logins storage + * @param savedLoginsController controller for the saved logins storage */ class EditLoginInteractor( private val savedLoginsController: SavedLoginsStorageController, diff --git a/app/src/main/java/org/mozilla/fenix/settings/logins/interactor/LoginDetailInteractor.kt b/app/src/main/java/org/mozilla/fenix/settings/logins/interactor/LoginDetailInteractor.kt index bd0149e44..5b06ebc0c 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/logins/interactor/LoginDetailInteractor.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/logins/interactor/LoginDetailInteractor.kt @@ -9,7 +9,7 @@ import org.mozilla.fenix.settings.logins.controller.SavedLoginsStorageController /** * Interactor for the login detail screen * - * @property savedLoginsController controller for the saved logins storage + * @param savedLoginsController controller for the saved logins storage */ class LoginDetailInteractor( private val savedLoginsController: SavedLoginsStorageController, diff --git a/app/src/main/java/org/mozilla/fenix/settings/logins/interactor/SavedLoginsInteractor.kt b/app/src/main/java/org/mozilla/fenix/settings/logins/interactor/SavedLoginsInteractor.kt index 0e8682e47..5f112d3bb 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/logins/interactor/SavedLoginsInteractor.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/logins/interactor/SavedLoginsInteractor.kt @@ -12,9 +12,9 @@ import org.mozilla.fenix.settings.logins.controller.SavedLoginsStorageController /** * Interactor for the saved logins screen * - * @property loginsListController [LoginsListController] which will be delegated for all + * @param loginsListController [LoginsListController] which will be delegated for all * user interactions. - * @property savedLoginsStorageController [SavedLoginsStorageController] which will be delegated + * @param savedLoginsStorageController [SavedLoginsStorageController] which will be delegated * for all calls to the password storage component */ class SavedLoginsInteractor( diff --git a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/ClearSiteDataView.kt b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/ClearSiteDataView.kt index f0d89491a..161d9f1cc 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/ClearSiteDataView.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/ClearSiteDataView.kt @@ -37,7 +37,7 @@ interface ClearSiteDataViewInteractor { * MVI View to access the dialog to clear site cookies and data. * * @property context An Android [Context]. - * @property ioScope [CoroutineScope] with an IO dispatcher used for structured concurrency. + * @param ioScope [CoroutineScope] with an IO dispatcher used for structured concurrency. * @property containerView [ViewGroup] in which this View will inflate itself. * @property containerDivider Divider [View] to manipulate. * @property interactor [ClearSiteDataViewInteractor] which will have delegated to all user diff --git a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/ConnectionDetailsInteractor.kt b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/ConnectionDetailsInteractor.kt index 9a45577e9..b870de03f 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/ConnectionDetailsInteractor.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/ConnectionDetailsInteractor.kt @@ -10,7 +10,7 @@ package org.mozilla.fenix.settings.quicksettings * Implements callbacks for each of [ConnectionPanelDialogFragment]'s Views declared possible user interactions, * delegates all such user events to the [ConnectionDetailsController]. * - * @property controller [ConnectionDetailsController] which will be delegated for all users interactions, + * @param controller [ConnectionDetailsController] which will be delegated for all users interactions, * it expected to contain all business logic for how to act in response. */ class ConnectionDetailsInteractor( diff --git a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/ConnectionDetailsView.kt b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/ConnectionDetailsView.kt index 037839cfa..c74e9c8c3 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/ConnectionDetailsView.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/ConnectionDetailsView.kt @@ -20,8 +20,8 @@ import org.mozilla.fenix.ext.loadIntoView * Currently it does not support any user interaction. * * @param container [ViewGroup] in which this View will inflate itself. - * @property icons Icons component for loading, caching and processing website icons. - * @property interactor [WebSiteInfoInteractor] which will have delegated to all user interactions. + * @param icons Icons component for loading, caching and processing website icons. + * @param interactor [WebSiteInfoInteractor] which will have delegated to all user interactions. */ class ConnectionDetailsView( container: ViewGroup, diff --git a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/QuickSettingsController.kt b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/QuickSettingsController.kt index 3768be853..68e49dab6 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/QuickSettingsController.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/QuickSettingsController.kt @@ -91,21 +91,21 @@ interface QuickSettingsController { /** * Default behavior of [QuickSettingsController]. Other implementations are possible. * - * @property context [Context] used for various Android interactions. - * @property quickSettingsStore [QuickSettingsFragmentStore] holding the State for all Views displayed + * @param context [Context] used for various Android interactions. + * @param quickSettingsStore [QuickSettingsFragmentStore] holding the State for all Views displayed * in this Controller's Fragment. - * @property browserStore The application's [BrowserStore]. - * @property ioScope [CoroutineScope] with an IO dispatcher used for structured concurrency. - * @property navController NavController] used for navigation. + * @param browserStore The application's [BrowserStore]. + * @param ioScope [CoroutineScope] with an IO dispatcher used for structured concurrency. + * @param navController NavController] used for navigation. * @property sessionId ID of the session to manipulate. * @property sitePermissions [SitePermissions]? list of website permissions and their status. - * @property settings [Settings] application settings. - * @property permissionStorage [PermissionStorage] app state for website permissions exception. - * @property reload [ReloadUrlUseCase] callback allowing for reloading the current web page. - * @property requestRuntimePermissions [OnNeedToRequestPermissions] callback allowing for requesting + * @param settings [Settings] application settings. + * @param permissionStorage [PermissionStorage] app state for website permissions exception. + * @param reload [ReloadUrlUseCase] callback allowing for reloading the current web page. + * @param requestRuntimePermissions [OnNeedToRequestPermissions] callback allowing for requesting * specific Android runtime permissions. - * @property displayPermissions callback for when [WebsitePermissionsView] needs to be displayed. - * @property engine An [Engine] instance used for clearing the browsing data. + * @param displayPermissions callback for when [WebsitePermissionsView] needs to be displayed. + * @param engine An [Engine] instance used for clearing the browsing data. */ @Suppress("TooManyFunctions", "LongParameterList") class DefaultQuickSettingsController( diff --git a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/QuickSettingsInteractor.kt b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/QuickSettingsInteractor.kt index 3d5215f2a..7dcac92b0 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/QuickSettingsInteractor.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/QuickSettingsInteractor.kt @@ -12,7 +12,7 @@ import org.mozilla.fenix.settings.quicksettings.protections.ProtectionsInteracto * Implements callbacks for each of [QuickSettingsSheetDialogFragment]'s Views declared possible user interactions, * delegates all such user events to the [QuickSettingsController]. * - * @property controller [QuickSettingsController] which will be delegated for all users interactions, + * @param controller [QuickSettingsController] which will be delegated for all users interactions, * it expected to contain all business logic for how to act in response. */ class QuickSettingsInteractor( diff --git a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/WebsiteInfoView.kt b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/WebsiteInfoView.kt index 71e5a94c8..7a7a80346 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/WebsiteInfoView.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/WebsiteInfoView.kt @@ -20,8 +20,8 @@ import org.mozilla.fenix.ext.loadIntoView * Currently it does not support any user interaction. * * @param container [ViewGroup] in which this View will inflate itself. - * @property icons Icons component for loading, caching and processing website icons. - * @property interactor [WebSiteInfoInteractor] which will have delegated to all user interactions. + * @param icons Icons component for loading, caching and processing website icons. + * @param interactor [WebSiteInfoInteractor] which will have delegated to all user interactions. */ class WebsiteInfoView( container: ViewGroup, diff --git a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/WebsitePermissionsView.kt b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/WebsitePermissionsView.kt index 16716af79..b3ae01ce3 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/WebsitePermissionsView.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/WebsitePermissionsView.kt @@ -62,7 +62,7 @@ interface WebsitePermissionInteractor { * - camera * * @param containerView [ViewGroup] in which this View will inflate itself. - * @property interactor [WebsitePermissionInteractor] which will have delegated to all user interactions. + * @param interactor [WebsitePermissionInteractor] which will have delegated to all user interactions. */ class WebsitePermissionsView( containerView: ViewGroup, diff --git a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/protections/ProtectionsView.kt b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/protections/ProtectionsView.kt index ea3f0b6fd..e46c86c78 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/protections/ProtectionsView.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/protections/ProtectionsView.kt @@ -41,7 +41,7 @@ import org.mozilla.fenix.utils.Settings * to additional tracking protection details. * * @property containerView [ViewGroup] in which this View will inflate itself. - * @property trackingProtectionDivider trackingProtectionDivider The divider line between tracking protection layout + * @param trackingProtectionDivider trackingProtectionDivider The divider line between tracking protection layout * and other views from [QuickSettingsSheetDialogFragment]. * @property interactor [ProtectionsInteractor] which will have delegated to all user interactions. * @property settings [Settings] application settings. diff --git a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/protections/cookiebanners/CookieBannerDetailsInteractor.kt b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/protections/cookiebanners/CookieBannerDetailsInteractor.kt index 90d0630b1..dce8ddd57 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/protections/cookiebanners/CookieBannerDetailsInteractor.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/protections/cookiebanners/CookieBannerDetailsInteractor.kt @@ -30,7 +30,7 @@ interface CookieBannerDetailsInteractor { * Implements callbacks for each of [CookieBannerPanelDialogFragment]'s Views declared possible user interactions, * delegates all such user events to the [CookieBannerDetailsController]. * - * @property controller [CookieBannerDetailsController] which will be delegated for all users interactions, + * @param controller [CookieBannerDetailsController] which will be delegated for all users interactions, * it expected to contain all business logic for how to act in response. */ class DefaultCookieBannerDetailsInteractor( diff --git a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/protections/cookiebanners/CookieBannerHandlingDetailsView.kt b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/protections/cookiebanners/CookieBannerHandlingDetailsView.kt index c58a074f2..97fad8636 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/quicksettings/protections/cookiebanners/CookieBannerHandlingDetailsView.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/quicksettings/protections/cookiebanners/CookieBannerHandlingDetailsView.kt @@ -26,11 +26,11 @@ import org.mozilla.fenix.trackingprotection.ProtectionsState * MVI View that knows how to display cookie banner handling details for a site. * * @param container [ViewGroup] in which this View will inflate itself. - * @property context An Android [Context]. - * @property ioScope [CoroutineScope] with an IO dispatcher used for structured concurrency. - * @property publicSuffixList To show short url. - * @property interactor [CookieBannerDetailsInteractor] which will have delegated to all user interactions. - * @property onDismiss Lambda invoked to dismiss the cookie banner. + * @param context An Android [Context]. + * @param ioScope [CoroutineScope] with an IO dispatcher used for structured concurrency. + * @param publicSuffixList To show short url. + * @param interactor [CookieBannerDetailsInteractor] which will have delegated to all user interactions. + * @param onDismiss Lambda invoked to dismiss the cookie banner. */ class CookieBannerHandlingDetailsView( container: ViewGroup, diff --git a/app/src/main/java/org/mozilla/fenix/settings/studies/StudiesAdapter.kt b/app/src/main/java/org/mozilla/fenix/settings/studies/StudiesAdapter.kt index 200d1efea..db715af00 100644 --- a/app/src/main/java/org/mozilla/fenix/settings/studies/StudiesAdapter.kt +++ b/app/src/main/java/org/mozilla/fenix/settings/studies/StudiesAdapter.kt @@ -32,12 +32,12 @@ private const val VIEW_HOLDER_TYPE_STUDY = 1 * An adapter for displaying studies items. This will display information related to the state of * a study such as active. In addition, it will perform actions such as removing a study. * - * @property studiesDelegate Delegate that will provides method for handling + * @param studiesDelegate Delegate that will provides method for handling * the studies actions items. * @param studies The list of studies. * * @property studiesDelegate Delegate that will provides method for handling * the studies actions items. - * @property shouldSubmitOnInit The sole purpose of this property is to prevent the submitList function + * @param shouldSubmitOnInit The sole purpose of this property is to prevent the submitList function * to run on init, it should only be used from tests. */ @Suppress("LargeClass") diff --git a/app/src/main/java/org/mozilla/fenix/share/SaveToPDFMiddleware.kt b/app/src/main/java/org/mozilla/fenix/share/SaveToPDFMiddleware.kt index eb1a10d4e..25f28887f 100644 --- a/app/src/main/java/org/mozilla/fenix/share/SaveToPDFMiddleware.kt +++ b/app/src/main/java/org/mozilla/fenix/share/SaveToPDFMiddleware.kt @@ -33,8 +33,8 @@ import java.io.IOException /** * [BrowserAction] middleware reacting in response to Save to PDF related [Action]s. * - * @property context An Application context. - * @property mainScope Coroutine scope to launch coroutines. + * @param context An Application context. + * @param mainScope Coroutine scope to launch coroutines. */ class SaveToPDFMiddleware( private val context: Context, diff --git a/app/src/main/java/org/mozilla/fenix/share/ShareController.kt b/app/src/main/java/org/mozilla/fenix/share/ShareController.kt index 2e149a699..9a1738484 100644 --- a/app/src/main/java/org/mozilla/fenix/share/ShareController.kt +++ b/app/src/main/java/org/mozilla/fenix/share/ShareController.kt @@ -74,19 +74,19 @@ interface ShareController { /** * Default behavior of [ShareController]. Other implementations are possible. * - * @property context [Context] used for various Android interactions. - * @property shareSubject Desired message subject used when sharing through 3rd party apps, like email clients. - * @property shareData The list of [ShareData]s that can be shared. - * @property sendTabUseCases Instance of [SendTabUseCases] which allows sending tabs to account devices. - * @property saveToPdfUseCase Instance of [SessionUseCases.SaveToPdfUseCase] to generate a PDF of a given tab. - * @property printUseCase Instance of [SessionUseCases.PrintContentUseCase] to print content of a given tab. - * @property snackbar Instance of [FenixSnackbar] for displaying styled snackbars. - * @property navController [NavController] used for navigation. - * @property recentAppsStorage Instance of [RecentAppsStorage] for storing and retrieving the most recent apps. - * @property viewLifecycleScope [CoroutineScope] used for retrieving the most recent apps in the background. - * @property dispatcher Dispatcher used to execute suspending functions. - * @property fxaEntrypoint The entrypoint if we need to authenticate, it will be reported in telemetry. - * @property dismiss Callback signalling sharing can be closed. + * @param context [Context] used for various Android interactions. + * @param shareSubject Desired message subject used when sharing through 3rd party apps, like email clients. + * @param shareData The list of [ShareData]s that can be shared. + * @param sendTabUseCases Instance of [SendTabUseCases] which allows sending tabs to account devices. + * @param saveToPdfUseCase Instance of [SessionUseCases.SaveToPdfUseCase] to generate a PDF of a given tab. + * @param printUseCase Instance of [SessionUseCases.PrintContentUseCase] to print content of a given tab. + * @param snackbar Instance of [FenixSnackbar] for displaying styled snackbars. + * @param navController [NavController] used for navigation. + * @param recentAppsStorage Instance of [RecentAppsStorage] for storing and retrieving the most recent apps. + * @param viewLifecycleScope [CoroutineScope] used for retrieving the most recent apps in the background. + * @param dispatcher Dispatcher used to execute suspending functions. + * @param fxaEntrypoint The entrypoint if we need to authenticate, it will be reported in telemetry. + * @param dismiss Callback signalling sharing can be closed. */ @Suppress("TooManyFunctions", "LongParameterList") class DefaultShareController( diff --git a/app/src/main/java/org/mozilla/fenix/shopping/ReviewQualityCheckBottomSheetStateFeature.kt b/app/src/main/java/org/mozilla/fenix/shopping/ReviewQualityCheckBottomSheetStateFeature.kt index bd8de32ca..5d307e02f 100644 --- a/app/src/main/java/org/mozilla/fenix/shopping/ReviewQualityCheckBottomSheetStateFeature.kt +++ b/app/src/main/java/org/mozilla/fenix/shopping/ReviewQualityCheckBottomSheetStateFeature.kt @@ -18,7 +18,7 @@ import org.mozilla.fenix.shopping.store.ReviewQualityCheckStore * the store state changes from [ReviewQualityCheckState.Initial] to [ReviewQualityCheckState.NotOptedIn]. * * @param store The store to observe. - * @property onRequestStateUpdate Callback to request the bottom sheet to be updated. + * @param onRequestStateUpdate Callback to request the bottom sheet to be updated. */ class ReviewQualityCheckBottomSheetStateFeature( store: ReviewQualityCheckStore, diff --git a/app/src/main/java/org/mozilla/fenix/shopping/ReviewQualityCheckFeature.kt b/app/src/main/java/org/mozilla/fenix/shopping/ReviewQualityCheckFeature.kt index 68363b762..e864c76b9 100644 --- a/app/src/main/java/org/mozilla/fenix/shopping/ReviewQualityCheckFeature.kt +++ b/app/src/main/java/org/mozilla/fenix/shopping/ReviewQualityCheckFeature.kt @@ -24,16 +24,16 @@ private const val DEBOUNCE_TIMEOUT_MILLIS = 200L * Feature implementation that provides review quality check information for supported product * pages. * - * @property appStore Reference to the application's [AppStore]. - * @property browserStore Reference to the application's [BrowserStore]. - * @property shoppingExperienceFeature Reference to the [ShoppingExperienceFeature]. - * @property onIconVisibilityChange Invoked when shopping icon visibility changes based on feature + * @param appStore Reference to the application's [AppStore]. + * @param browserStore Reference to the application's [BrowserStore]. + * @param shoppingExperienceFeature Reference to the [ShoppingExperienceFeature]. + * @param onIconVisibilityChange Invoked when shopping icon visibility changes based on feature * flag and when the loaded page is a supported product page. - * @property onBottomSheetStateChange Invoked when the bottom sheet is collapsed or expanded. - * @property debounceTimeoutMillis Function that returns the debounce timeout in milliseconds. This + * @param onBottomSheetStateChange Invoked when the bottom sheet is collapsed or expanded. + * @param debounceTimeoutMillis Function that returns the debounce timeout in milliseconds. This * make it possible to wait till [ContentState.isProductUrl] is stable before invoking * [onIconVisibilityChange]. - * @property onProductPageDetected Invoked when a product page is detected and loaded. Used to + * @param onProductPageDetected Invoked when a product page is detected and loaded. Used to * detect when to send telemetry for shopping.product_page_visits. */ @OptIn(FlowPreview::class) diff --git a/app/src/main/java/org/mozilla/fenix/shopping/middleware/GetReviewQualityCheckSumoUrl.kt b/app/src/main/java/org/mozilla/fenix/shopping/middleware/GetReviewQualityCheckSumoUrl.kt index 155bd8231..6c410dff9 100644 --- a/app/src/main/java/org/mozilla/fenix/shopping/middleware/GetReviewQualityCheckSumoUrl.kt +++ b/app/src/main/java/org/mozilla/fenix/shopping/middleware/GetReviewQualityCheckSumoUrl.kt @@ -16,7 +16,7 @@ private const val PARAM_UTM_TERM_VALUE = "core-sheet" /** * Class used to retrieve the SUMO review quality check link. * - * @property context Context used to localize the SUMO url. + * @param context Context used to localize the SUMO url. */ class GetReviewQualityCheckSumoUrl( private val context: Context, diff --git a/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckNavigationMiddleware.kt b/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckNavigationMiddleware.kt index 105a91105..2edb8396c 100644 --- a/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckNavigationMiddleware.kt +++ b/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckNavigationMiddleware.kt @@ -19,8 +19,8 @@ private const val TERMS_OF_USE_URL = "https://www.fakespot.com/terms" /** * Middleware that handles navigation events for the review quality check feature. * - * @property selectOrAddUseCase UseCase instance used to open new tabs. - * @property getReviewQualityCheckSumoUrl Instance used to retrieve the learn more SUMO link. + * @param selectOrAddUseCase UseCase instance used to open new tabs. + * @param getReviewQualityCheckSumoUrl Instance used to retrieve the learn more SUMO link. */ class ReviewQualityCheckNavigationMiddleware( private val selectOrAddUseCase: TabsUseCases.SelectOrAddUseCase, diff --git a/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckNetworkMiddleware.kt b/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckNetworkMiddleware.kt index f03362577..832f7f96d 100644 --- a/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckNetworkMiddleware.kt +++ b/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckNetworkMiddleware.kt @@ -24,10 +24,10 @@ import org.mozilla.fenix.shopping.store.ReviewQualityCheckState.RecommendedProdu /** * Middleware that handles network requests for the review quality check feature. * - * @property reviewQualityCheckService The service that handles the network requests. - * @property networkChecker The [NetworkChecker] instance to check the network status. - * @property appStore The [AppStore] instance to access state and dispatch [ShoppingAction]s. - * @property scope The [CoroutineScope] that will be used to launch coroutines. + * @param reviewQualityCheckService The service that handles the network requests. + * @param networkChecker The [NetworkChecker] instance to check the network status. + * @param appStore The [AppStore] instance to access state and dispatch [ShoppingAction]s. + * @param scope The [CoroutineScope] that will be used to launch coroutines. */ class ReviewQualityCheckNetworkMiddleware( private val reviewQualityCheckService: ReviewQualityCheckService, diff --git a/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckPreferences.kt b/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckPreferences.kt index d1fbf9925..af9d82b30 100644 --- a/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckPreferences.kt +++ b/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckPreferences.kt @@ -44,7 +44,7 @@ interface ReviewQualityCheckPreferences { * Implementation of [ReviewQualityCheckPreferences] that uses [Settings] to store/fetch * preferences. * - * @property settings The [Settings] instance to use. + * @param settings The [Settings] instance to use. */ class DefaultReviewQualityCheckPreferences( private val settings: Settings, diff --git a/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckPreferencesMiddleware.kt b/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckPreferencesMiddleware.kt index 424a09a63..be9680e05 100644 --- a/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckPreferencesMiddleware.kt +++ b/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckPreferencesMiddleware.kt @@ -15,11 +15,11 @@ import org.mozilla.fenix.shopping.store.ReviewQualityCheckState /** * Middleware for getting and setting review quality check user preferences. * - * @property reviewQualityCheckPreferences The [ReviewQualityCheckPreferences] instance to get and + * @param reviewQualityCheckPreferences The [ReviewQualityCheckPreferences] instance to get and * set preferences for the review quality check feature. - * @property reviewQualityCheckVendorsService The [ReviewQualityCheckVendorsService] instance for + * @param reviewQualityCheckVendorsService The [ReviewQualityCheckVendorsService] instance for * getting the list of product vendors. - * @property scope The [CoroutineScope] to use for launching coroutines. + * @param scope The [CoroutineScope] to use for launching coroutines. */ class ReviewQualityCheckPreferencesMiddleware( private val reviewQualityCheckPreferences: ReviewQualityCheckPreferences, diff --git a/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckService.kt b/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckService.kt index 3267056dc..b39a3847c 100644 --- a/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckService.kt +++ b/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckService.kt @@ -56,7 +56,7 @@ interface ReviewQualityCheckService { /** * Service that handles the network requests for the review quality check feature. * - * @property browserStore Reference to the application's [BrowserStore] to access state. + * @param browserStore Reference to the application's [BrowserStore] to access state. */ class DefaultReviewQualityCheckService( private val browserStore: BrowserStore, diff --git a/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckVendorsService.kt b/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckVendorsService.kt index 9f594d858..6a8522332 100644 --- a/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckVendorsService.kt +++ b/app/src/main/java/org/mozilla/fenix/shopping/middleware/ReviewQualityCheckVendorsService.kt @@ -31,7 +31,7 @@ interface ReviewQualityCheckVendorsService { * Default implementation of [ReviewQualityCheckVendorsService] that uses the [BrowserStore] to * identify the selected tab. * - * @property browserStore The [BrowserStore] instance to use. + * @param browserStore The [BrowserStore] instance to use. */ class DefaultReviewQualityCheckVendorsService( private val browserStore: BrowserStore, diff --git a/app/src/main/java/org/mozilla/fenix/sync/SyncedTabsIntegration.kt b/app/src/main/java/org/mozilla/fenix/sync/SyncedTabsIntegration.kt index 1238c71b4..dc39ac1dd 100644 --- a/app/src/main/java/org/mozilla/fenix/sync/SyncedTabsIntegration.kt +++ b/app/src/main/java/org/mozilla/fenix/sync/SyncedTabsIntegration.kt @@ -15,8 +15,8 @@ import org.mozilla.fenix.ext.components /** * Starts and stops SyncedTabsStorage based on the authentication state. * - * @property context Used to get synced tabs storage, due to cyclic dependency. - * @property accountManager Used to check and observe account authentication state. + * @param context Used to get synced tabs storage, due to cyclic dependency. + * @param accountManager Used to check and observe account authentication state. */ class SyncedTabsIntegration( private val context: Context, diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/TabSheetBehaviorManager.kt b/app/src/main/java/org/mozilla/fenix/tabstray/TabSheetBehaviorManager.kt index 33f3745b4..05acedbb5 100644 --- a/app/src/main/java/org/mozilla/fenix/tabstray/TabSheetBehaviorManager.kt +++ b/app/src/main/java/org/mozilla/fenix/tabstray/TabSheetBehaviorManager.kt @@ -30,11 +30,11 @@ private const val DIM_CONVERSION = 1000f /** * Helper class for updating how the tray looks and behaves depending on app state / internal tray state. * - * @property behavior [BottomSheetBehavior] that will actually control the tray. + * @param behavior [BottomSheetBehavior] that will actually control the tray. * @param orientation current Configuration.ORIENTATION_* of the device. - * @property maxNumberOfTabs highest number of tabs in each tray page. - * @property numberForExpandingTray limit depending on which the tray should be collapsed or expanded. - * @property displayMetrics [DisplayMetrics] used for adapting resources to the current display. + * @param maxNumberOfTabs highest number of tabs in each tray page. + * @param numberForExpandingTray limit depending on which the tray should be collapsed or expanded. + * @param displayMetrics [DisplayMetrics] used for adapting resources to the current display. */ internal class TabSheetBehaviorManager( private val behavior: BottomSheetBehavior, diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/TabsTrayController.kt b/app/src/main/java/org/mozilla/fenix/tabstray/TabsTrayController.kt index d9c9346cc..1a657533f 100644 --- a/app/src/main/java/org/mozilla/fenix/tabstray/TabsTrayController.kt +++ b/app/src/main/java/org/mozilla/fenix/tabstray/TabsTrayController.kt @@ -172,26 +172,26 @@ interface TabsTrayController : SyncedTabsController, InactiveTabsController, Tab /** * Default implementation of [TabsTrayController]. * - * @property activity [HomeActivity] used to perform top-level app actions. - * @property appStore [AppStore] used to dispatch any [AppAction]. - * @property tabsTrayStore [TabsTrayStore] used to read/update the [TabsTrayState]. - * @property browserStore [BrowserStore] used to read/update the current [BrowserState]. - * @property settings [Settings] used to update any user preferences. - * @property browsingModeManager [BrowsingModeManager] used to read/update the current [BrowsingMode]. - * @property navController [NavController] used to navigate away from the tabs tray. - * @property navigateToHomeAndDeleteSession Lambda used to return to the Homescreen and delete the current session. - * @property profiler [Profiler] used to add profiler markers. - * @property navigationInteractor [NavigationInteractor] used to perform navigation actions with side effects. - * @property tabsUseCases Use case wrapper for interacting with tabs. - * @property bookmarksUseCase Use case wrapper for interacting with bookmarks. - * @property ioDispatcher [CoroutineContext] used to handle saving tabs as bookmarks. - * @property collectionStorage Storage layer for interacting with collections. - * @property selectTabPosition Lambda used to scroll the tabs tray to the desired position. - * @property dismissTray Lambda used to dismiss/minimize the tabs tray. - * @property showUndoSnackbarForTab Lambda used to display an UNDO Snackbar. + * @param activity [HomeActivity] used to perform top-level app actions. + * @param appStore [AppStore] used to dispatch any [AppAction]. + * @param tabsTrayStore [TabsTrayStore] used to read/update the [TabsTrayState]. + * @param browserStore [BrowserStore] used to read/update the current [BrowserState]. + * @param settings [Settings] used to update any user preferences. + * @param browsingModeManager [BrowsingModeManager] used to read/update the current [BrowsingMode]. + * @param navController [NavController] used to navigate away from the tabs tray. + * @param navigateToHomeAndDeleteSession Lambda used to return to the Homescreen and delete the current session. + * @param profiler [Profiler] used to add profiler markers. + * @param navigationInteractor [NavigationInteractor] used to perform navigation actions with side effects. + * @param tabsUseCases Use case wrapper for interacting with tabs. + * @param bookmarksUseCase Use case wrapper for interacting with bookmarks. + * @param ioDispatcher [CoroutineContext] used to handle saving tabs as bookmarks. + * @param collectionStorage Storage layer for interacting with collections. + * @param selectTabPosition Lambda used to scroll the tabs tray to the desired position. + * @param dismissTray Lambda used to dismiss/minimize the tabs tray. + * @param showUndoSnackbarForTab Lambda used to display an UNDO Snackbar. * @property showCancelledDownloadWarning Lambda used to display a cancelled download warning. - * @property showBookmarkSnackbar Lambda used to display a snackbar upon saving tabs as bookmarks. - * @property showCollectionSnackbar Lambda used to display a snackbar upon successfully saving tabs + * @param showBookmarkSnackbar Lambda used to display a snackbar upon saving tabs as bookmarks. + * @param showCollectionSnackbar Lambda used to display a snackbar upon successfully saving tabs * to a collection. */ @Suppress("TooManyFunctions", "LongParameterList") diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/TabsTrayInteractor.kt b/app/src/main/java/org/mozilla/fenix/tabstray/TabsTrayInteractor.kt index 6d19b590c..b9f8bb547 100644 --- a/app/src/main/java/org/mozilla/fenix/tabstray/TabsTrayInteractor.kt +++ b/app/src/main/java/org/mozilla/fenix/tabstray/TabsTrayInteractor.kt @@ -110,7 +110,7 @@ interface TabsTrayInteractor : /** * Default implementation of [TabsTrayInteractor]. * - * @property controller [TabsTrayController] to which user actions can be delegated for app updates. + * @param controller [TabsTrayController] to which user actions can be delegated for app updates. */ @Suppress("TooManyFunctions") class DefaultTabsTrayInteractor( diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/browser/AbstractBrowserTabViewHolder.kt b/app/src/main/java/org/mozilla/fenix/tabstray/browser/AbstractBrowserTabViewHolder.kt index 18ec21eba..de5a5cd07 100644 --- a/app/src/main/java/org/mozilla/fenix/tabstray/browser/AbstractBrowserTabViewHolder.kt +++ b/app/src/main/java/org/mozilla/fenix/tabstray/browser/AbstractBrowserTabViewHolder.kt @@ -48,11 +48,11 @@ import org.mozilla.fenix.tabstray.ext.toDisplayTitle * A RecyclerView ViewHolder implementation for "tab" items. * * @param itemView [View] that displays a "tab". - * @property imageLoader [ImageLoader] used to load tab thumbnails. - * @property trayStore [TabsTrayStore] containing the complete state of tabs tray and methods to update that. - * @property selectionHolder [SelectionHolder] instance containing the selected tabs in the tabs tray. + * @param imageLoader [ImageLoader] used to load tab thumbnails. + * @param trayStore [TabsTrayStore] containing the complete state of tabs tray and methods to update that. + * @param selectionHolder [SelectionHolder] instance containing the selected tabs in the tabs tray. * @property featureName [String] representing the name of the feature displaying tabs. Used in telemetry reporting. - * @property store [BrowserStore] containing the complete state of the browser and methods to update that. + * @param store [BrowserStore] containing the complete state of the browser and methods to update that. */ @Suppress("LongParameterList") abstract class AbstractBrowserTabViewHolder( diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/browser/BrowserTabsAdapter.kt b/app/src/main/java/org/mozilla/fenix/tabstray/browser/BrowserTabsAdapter.kt index b1eb3bfc6..b2286dd27 100644 --- a/app/src/main/java/org/mozilla/fenix/tabstray/browser/BrowserTabsAdapter.kt +++ b/app/src/main/java/org/mozilla/fenix/tabstray/browser/BrowserTabsAdapter.kt @@ -29,9 +29,9 @@ import org.mozilla.fenix.tabstray.browser.compose.ComposeListViewHolder /** * A [RecyclerView.Adapter] for browser tabs. * - * @property context [Context] used for various platform interactions or accessing [Components] + * @param context [Context] used for various platform interactions or accessing [Components] * @property interactor [TabsTrayInteractor] handling tabs interactions in a tab tray. - * @property store [TabsTrayStore] containing the complete state of tabs tray and methods to update that. + * @param store [TabsTrayStore] containing the complete state of tabs tray and methods to update that. * @property featureName [String] representing the name of the feature displaying tabs. Used in telemetry reporting. * @property viewLifecycleOwner [LifecycleOwner] life cycle owner for the view. */ diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/browser/InactiveTabViewHolder.kt b/app/src/main/java/org/mozilla/fenix/tabstray/browser/InactiveTabViewHolder.kt index 4d29687fa..e8c96761e 100644 --- a/app/src/main/java/org/mozilla/fenix/tabstray/browser/InactiveTabViewHolder.kt +++ b/app/src/main/java/org/mozilla/fenix/tabstray/browser/InactiveTabViewHolder.kt @@ -30,8 +30,8 @@ import org.mozilla.fenix.GleanMetrics.TabsTray as TabsTrayMetrics * * @param composeView [ComposeView] which will be populated with Jetpack Compose UI content. * @param lifecycleOwner [LifecycleOwner] to which this Composable will be tied to. - * @property tabsTrayStore [TabsTrayStore] used to listen for changes to [TabsTrayState.inactiveTabs]. - * @property interactor [InactiveTabsInteractor] used to respond to interactions with the inactive tabs header + * @param tabsTrayStore [TabsTrayStore] used to listen for changes to [TabsTrayState.inactiveTabs]. + * @param interactor [InactiveTabsInteractor] used to respond to interactions with the inactive tabs header * and the auto close dialog. */ @Suppress("LongParameterList") diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/browser/InactiveTabsAdapter.kt b/app/src/main/java/org/mozilla/fenix/tabstray/browser/InactiveTabsAdapter.kt index 5a8044881..30ce40632 100644 --- a/app/src/main/java/org/mozilla/fenix/tabstray/browser/InactiveTabsAdapter.kt +++ b/app/src/main/java/org/mozilla/fenix/tabstray/browser/InactiveTabsAdapter.kt @@ -14,9 +14,9 @@ import org.mozilla.fenix.tabstray.TabsTrayStore /** * The adapter for displaying the section of inactive tabs. * - * @property lifecycleOwner [LifecycleOwner] to which the Composable will be tied to. - * @property tabsTrayStore [TabsTrayStore] used to listen for changes to [TabsTrayState.inactiveTabs]. - * @property interactor [InactiveTabsInteractor] used to respond to interactions with the inactive tabs header + * @param lifecycleOwner [LifecycleOwner] to which the Composable will be tied to. + * @param tabsTrayStore [TabsTrayStore] used to listen for changes to [TabsTrayState.inactiveTabs]. + * @param interactor [InactiveTabsInteractor] used to respond to interactions with the inactive tabs header * and the auto close dialog. * @property featureName [String] representing the name of the inactive tabs feature for telemetry reporting. */ diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/browser/SelectionBannerBinding.kt b/app/src/main/java/org/mozilla/fenix/tabstray/browser/SelectionBannerBinding.kt index 31dc4139d..34c347966 100644 --- a/app/src/main/java/org/mozilla/fenix/tabstray/browser/SelectionBannerBinding.kt +++ b/app/src/main/java/org/mozilla/fenix/tabstray/browser/SelectionBannerBinding.kt @@ -28,13 +28,13 @@ import org.mozilla.fenix.tabstray.ext.showWithTheme /** * A binding that shows/hides the multi-select banner of the selected count of tabs. * - * @property context An Android context. - * @property binding The binding used to display the view. - * @property store [TabsTrayStore] used to listen for changes to [TabsTrayState] and dispatch actions. - * @property interactor [TabsTrayInteractor] for responding to user actions. - * @property backgroundView The background view that we want to alter when changing [Mode]. - * @property showOnSelectViews A variable list of views that will be made visible when in select mode. - * @property showOnNormalViews A variable list of views that will be made visible when in normal mode. + * @param context An Android context. + * @param binding The binding used to display the view. + * @param store [TabsTrayStore] used to listen for changes to [TabsTrayState] and dispatch actions. + * @param interactor [TabsTrayInteractor] for responding to user actions. + * @param backgroundView The background view that we want to alter when changing [Mode]. + * @param showOnSelectViews A variable list of views that will be made visible when in select mode. + * @param showOnNormalViews A variable list of views that will be made visible when in normal mode. */ @OptIn(ExperimentalCoroutinesApi::class) @Suppress("LongParameterList") diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/browser/SelectionHandleBinding.kt b/app/src/main/java/org/mozilla/fenix/tabstray/browser/SelectionHandleBinding.kt index ee999934a..a45c38d96 100644 --- a/app/src/main/java/org/mozilla/fenix/tabstray/browser/SelectionHandleBinding.kt +++ b/app/src/main/java/org/mozilla/fenix/tabstray/browser/SelectionHandleBinding.kt @@ -27,8 +27,8 @@ private const val NORMAL_HANDLE_PERCENT_WIDTH = 0.1F * between [Mode]. * * @param store The TabsTrayStore instance. - * @property handle The "handle" of the Tabs Tray that is used to drag the tray open/close. - * @property containerLayout The [ConstraintLayout] that contains the "handle". + * @param handle The "handle" of the Tabs Tray that is used to drag the tray open/close. + * @param containerLayout The [ConstraintLayout] that contains the "handle". */ @OptIn(ExperimentalCoroutinesApi::class) class SelectionHandleBinding( diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/browser/TabsTouchHelper.kt b/app/src/main/java/org/mozilla/fenix/tabstray/browser/TabsTouchHelper.kt index 4b9a0bc45..b9d762f2f 100644 --- a/app/src/main/java/org/mozilla/fenix/tabstray/browser/TabsTouchHelper.kt +++ b/app/src/main/java/org/mozilla/fenix/tabstray/browser/TabsTouchHelper.kt @@ -51,8 +51,8 @@ class TabsTouchHelper( * An [ItemTouchHelper.Callback] for drawing custom layouts on [RecyclerView.ViewHolder] interactions. * * @param delegate [TabsTray.Delegate] for handling all user interactions. - * @property onViewHolderTouched Invoked when a tab is about to be swiped. See [OnViewHolderTouched]. - * @property onViewHolderDraw Invoked when a tab is drawn. See [OnViewHolderToDraw]. + * @param onViewHolderTouched Invoked when a tab is about to be swiped. See [OnViewHolderTouched]. + * @param onViewHolderDraw Invoked when a tab is drawn. See [OnViewHolderToDraw]. * @param featureNameHolder Contains the identifying name of the feature. * @param onRemove A callback invoked when a tab is removed. */ diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ComposeAbstractTabViewHolder.kt b/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ComposeAbstractTabViewHolder.kt index 53fb07739..59f575212 100644 --- a/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ComposeAbstractTabViewHolder.kt +++ b/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ComposeAbstractTabViewHolder.kt @@ -20,8 +20,8 @@ import org.mozilla.fenix.theme.Theme /** * [RecyclerView.ViewHolder] used for Jetpack Compose UI content . * - * @property composeView [ComposeView] which will be populated with Jetpack Compose UI content. - * @property viewLifecycleOwner [LifecycleOwner] life cycle owner for the view. + * @param composeView [ComposeView] which will be populated with Jetpack Compose UI content. + * @param viewLifecycleOwner [LifecycleOwner] life cycle owner for the view. */ abstract class ComposeAbstractTabViewHolder( private val composeView: ComposeView, diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ComposeGridViewHolder.kt b/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ComposeGridViewHolder.kt index c2401df50..49d28f597 100644 --- a/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ComposeGridViewHolder.kt +++ b/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ComposeGridViewHolder.kt @@ -24,10 +24,10 @@ import org.mozilla.fenix.tabstray.TabsTrayStore /** * A Compose ViewHolder implementation for "tab" items with grid layout. * - * @property interactor [TabsTrayInteractor] handling tabs interactions in a tab tray. - * @property store [TabsTrayStore] containing the complete state of tabs tray and methods to update that. + * @param interactor [TabsTrayInteractor] handling tabs interactions in a tab tray. + * @param store [TabsTrayStore] containing the complete state of tabs tray and methods to update that. * @param composeItemView that displays a "tab". - * @property featureName [String] representing the name of the feature displaying tabs. Used in telemetry reporting. + * @param featureName [String] representing the name of the feature displaying tabs. Used in telemetry reporting. * @param viewLifecycleOwner [LifecycleOwner] to which this Composable will be tied to. */ class ComposeGridViewHolder( diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ComposeListViewHolder.kt b/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ComposeListViewHolder.kt index 4d966c8f0..acfe9e1b3 100644 --- a/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ComposeListViewHolder.kt +++ b/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ComposeListViewHolder.kt @@ -24,10 +24,10 @@ import org.mozilla.fenix.tabstray.TabsTrayStore /** * A Compose ViewHolder implementation for "tab" items with list layout. * - * @property interactor [TabsTrayInteractor] handling tabs interactions in a tab tray. - * @property tabsTrayStore [TabsTrayStore] containing the complete state of tabs tray and methods to update that. + * @param interactor [TabsTrayInteractor] handling tabs interactions in a tab tray. + * @param tabsTrayStore [TabsTrayStore] containing the complete state of tabs tray and methods to update that. * @param composeItemView that displays a "tab". - * @property featureName [String] representing the name of the feature displaying tabs. Used in telemetry reporting. + * @param featureName [String] representing the name of the feature displaying tabs. Used in telemetry reporting. * @param viewLifecycleOwner [LifecycleOwner] to which this Composable will be tied to. */ class ComposeListViewHolder( diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ReorderableGrid.kt b/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ReorderableGrid.kt index 7c5e8fa34..45a809b1c 100644 --- a/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ReorderableGrid.kt +++ b/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ReorderableGrid.kt @@ -77,14 +77,14 @@ fun createGridReorderState( /** * Class containing details about the current state of dragging in grid. * - * @property gridState State of the grid. - * @property scope [CoroutineScope] used for scrolling to the target item. - * @property hapticFeedback [HapticFeedback] used for performing haptic feedback on item long press. - * @property touchSlop Distance in pixels the user can wander until we consider they started dragging. - * @property onMove Callback to be invoked when switching between two items. - * @property onLongPress Optional callback to be invoked when long pressing an item. - * @property onExitLongPress Optional callback to be invoked when the item is dragged after long press. - * @property ignoredItems List of keys for non-draggable items. + * @param gridState State of the grid. + * @param scope [CoroutineScope] used for scrolling to the target item. + * @param hapticFeedback [HapticFeedback] used for performing haptic feedback on item long press. + * @param touchSlop Distance in pixels the user can wander until we consider they started dragging. + * @param onMove Callback to be invoked when switching between two items. + * @param onLongPress Optional callback to be invoked when long pressing an item. + * @param onExitLongPress Optional callback to be invoked when the item is dragged after long press. + * @param ignoredItems List of keys for non-draggable items. */ class GridReorderState internal constructor( private val gridState: LazyGridState, diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ReorderableList.kt b/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ReorderableList.kt index cb162d049..bc0bf49f2 100644 --- a/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ReorderableList.kt +++ b/app/src/main/java/org/mozilla/fenix/tabstray/browser/compose/ReorderableList.kt @@ -72,14 +72,14 @@ fun createListReorderState( /** * Class containing details about the current state of dragging in list. * - * @property listState State of the list. - * @property scope [CoroutineScope] used for scrolling to the target item. - * @property hapticFeedback [HapticFeedback] used for performing haptic feedback on item long press. - * @property touchSlop Distance in pixels the user can wander until we consider they started dragging. - * @property onMove Callback to be invoked when switching between two items. - * @property ignoredItems List of keys for non-draggable items. - * @property onLongPress Optional callback to be invoked when long pressing an item. - * @property onExitLongPress Optional callback to be invoked when the item is dragged after long press. + * @param listState State of the list. + * @param scope [CoroutineScope] used for scrolling to the target item. + * @param hapticFeedback [HapticFeedback] used for performing haptic feedback on item long press. + * @param touchSlop Distance in pixels the user can wander until we consider they started dragging. + * @param onMove Callback to be invoked when switching between two items. + * @param ignoredItems List of keys for non-draggable items. + * @param onLongPress Optional callback to be invoked when long pressing an item. + * @param onExitLongPress Optional callback to be invoked when the item is dragged after long press. */ @Suppress("LongParameterList") class ListReorderState internal constructor( diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/syncedtabs/SyncedTabsIntegration.kt b/app/src/main/java/org/mozilla/fenix/tabstray/syncedtabs/SyncedTabsIntegration.kt index a10817679..2bc7814e5 100644 --- a/app/src/main/java/org/mozilla/fenix/tabstray/syncedtabs/SyncedTabsIntegration.kt +++ b/app/src/main/java/org/mozilla/fenix/tabstray/syncedtabs/SyncedTabsIntegration.kt @@ -24,9 +24,9 @@ import org.mozilla.fenix.tabstray.ext.toSyncedTabsListItem /** * TabsTrayFragment delegate to handle all layout updates needed to display synced tabs and any errors. * - * @property store An instance of [TabsTrayStore] used to manage the tabs tray state. - * @property context Fragment context. - * @property navController The controller used to handle any navigation necessary for error scenarios. + * @param store An instance of [TabsTrayStore] used to manage the tabs tray state. + * @param context Fragment context. + * @param navController The controller used to handle any navigation necessary for error scenarios. * @param storage An instance of [SyncedTabsStorage] used for retrieving synced tabs. * @param accountManager An instance of [FxaAccountManager] used for synced tabs authentication. * @param lifecycleOwner View lifecycle owner used to determine when to cancel UI jobs. diff --git a/app/src/main/java/org/mozilla/fenix/tabstray/viewholders/SyncedTabsPageViewHolder.kt b/app/src/main/java/org/mozilla/fenix/tabstray/viewholders/SyncedTabsPageViewHolder.kt index d4a60aea5..58ef98f1f 100644 --- a/app/src/main/java/org/mozilla/fenix/tabstray/viewholders/SyncedTabsPageViewHolder.kt +++ b/app/src/main/java/org/mozilla/fenix/tabstray/viewholders/SyncedTabsPageViewHolder.kt @@ -18,9 +18,9 @@ import org.mozilla.fenix.theme.Theme /** * Temporary ViewHolder to render [SyncedTabsList] until all of the Tabs Tray is written in Compose. * - * @property composeView Root ComposeView passed-in from TrayPagerAdapter. - * @property tabsTrayStore Store used as a Composable State to listen for changes to [TabsTrayState.syncedTabs]. - * @property interactor [SyncedTabsInteractor] used to respond to interactions with synced tabs. + * @param composeView Root ComposeView passed-in from TrayPagerAdapter. + * @param tabsTrayStore Store used as a Composable State to listen for changes to [TabsTrayState.syncedTabs]. + * @param interactor [SyncedTabsInteractor] used to respond to interactions with synced tabs. */ class SyncedTabsPageViewHolder( private val composeView: ComposeView, diff --git a/app/src/main/java/org/mozilla/fenix/telemetry/TelemetryMiddleware.kt b/app/src/main/java/org/mozilla/fenix/telemetry/TelemetryMiddleware.kt index fb7ef13c2..3b448bdb4 100644 --- a/app/src/main/java/org/mozilla/fenix/telemetry/TelemetryMiddleware.kt +++ b/app/src/main/java/org/mozilla/fenix/telemetry/TelemetryMiddleware.kt @@ -39,13 +39,13 @@ private const val PROGRESS_COMPLETE = 100 /** * [Middleware] to record telemetry in response to [BrowserAction]s. * - * @property context An Android [Context]. - * @property settings reference to the application [Settings]. - * @property metrics [MetricController] to pass events that have been mapped from actions. - * @property crashReporting An instance of [CrashReporting] to report caught exceptions. - * @property nimbusSearchEngine The Nimbus search engine. - * @property searchState Map that stores the [TabSessionState.id] & [TimerId]. - * @property timerId The [TimerId] for the [Metrics.searchPageLoadTime]. + * @param context An Android [Context]. + * @param settings reference to the application [Settings]. + * @param metrics [MetricController] to pass events that have been mapped from actions. + * @param crashReporting An instance of [CrashReporting] to report caught exceptions. + * @param nimbusSearchEngine The Nimbus search engine. + * @param searchState Map that stores the [TabSessionState.id] & [TimerId]. + * @param timerId The [TimerId] for the [Metrics.searchPageLoadTime]. */ class TelemetryMiddleware( private val context: Context, diff --git a/app/src/main/java/org/mozilla/fenix/utils/Settings.kt b/app/src/main/java/org/mozilla/fenix/utils/Settings.kt index dbda0511b..bbe912179 100644 --- a/app/src/main/java/org/mozilla/fenix/utils/Settings.kt +++ b/app/src/main/java/org/mozilla/fenix/utils/Settings.kt @@ -62,7 +62,7 @@ private const val AUTOPLAY_USER_SETTING = "AUTOPLAY_USER_SETTING" /** * A simple wrapper for SharedPreferences that makes reading preference a little bit easier. * - * @property appContext Reference to application context. + * @param appContext Reference to application context. */ @Suppress("LargeClass", "TooManyFunctions") class Settings(private val appContext: Context) : PreferencesHolder { diff --git a/app/src/main/java/org/mozilla/fenix/wallpapers/LegacyWallpaperMigration.kt b/app/src/main/java/org/mozilla/fenix/wallpapers/LegacyWallpaperMigration.kt index e3ab62e79..5bc8926a3 100644 --- a/app/src/main/java/org/mozilla/fenix/wallpapers/LegacyWallpaperMigration.kt +++ b/app/src/main/java/org/mozilla/fenix/wallpapers/LegacyWallpaperMigration.kt @@ -19,9 +19,9 @@ import java.io.IOException /** * Manages the migration of legacy wallpapers to the new paths * - * @property storageRootDirectory The top level app-local storage directory. - * @property settings Used to update the color of the text shown above wallpapers. - * @property downloadWallpaper Function used to download assets for legacy drawable wallpapers. + * @param storageRootDirectory The top level app-local storage directory. + * @param settings Used to update the color of the text shown above wallpapers. + * @param downloadWallpaper Function used to download assets for legacy drawable wallpapers. */ class LegacyWallpaperMigration( private val storageRootDirectory: File, diff --git a/app/src/main/java/org/mozilla/fenix/wallpapers/WallpaperDownloader.kt b/app/src/main/java/org/mozilla/fenix/wallpapers/WallpaperDownloader.kt index eac034584..2beff12a7 100644 --- a/app/src/main/java/org/mozilla/fenix/wallpapers/WallpaperDownloader.kt +++ b/app/src/main/java/org/mozilla/fenix/wallpapers/WallpaperDownloader.kt @@ -18,9 +18,9 @@ import java.lang.IllegalStateException /** * Can download wallpapers from a remote host. * - * @property storageRootDirectory The top level app-local storage directory. - * @property client Required for fetching files from network. - * @property dispatcher Dispatcher used to execute suspending functions. Default parameter + * @param storageRootDirectory The top level app-local storage directory. + * @param client Required for fetching files from network. + * @param dispatcher Dispatcher used to execute suspending functions. Default parameter * should be likely be used except for when under test. */ class WallpaperDownloader( diff --git a/app/src/main/java/org/mozilla/fenix/wallpapers/WallpaperFileManager.kt b/app/src/main/java/org/mozilla/fenix/wallpapers/WallpaperFileManager.kt index 2c9112d25..e31ac7662 100644 --- a/app/src/main/java/org/mozilla/fenix/wallpapers/WallpaperFileManager.kt +++ b/app/src/main/java/org/mozilla/fenix/wallpapers/WallpaperFileManager.kt @@ -16,8 +16,8 @@ import java.io.File /** * Manages various functions related to the locally-stored wallpaper assets. * - * @property storageRootDirectory The top level app-local storage directory. - * @property coroutineDispatcher Dispatcher used to execute suspending functions. Default parameter + * @param storageRootDirectory The top level app-local storage directory. + * @param coroutineDispatcher Dispatcher used to execute suspending functions. Default parameter * should be likely be used except for when under test. */ class WallpaperFileManager( diff --git a/app/src/main/java/org/mozilla/fenix/wallpapers/WallpaperMetadataFetcher.kt b/app/src/main/java/org/mozilla/fenix/wallpapers/WallpaperMetadataFetcher.kt index d16d89472..96a50ee57 100644 --- a/app/src/main/java/org/mozilla/fenix/wallpapers/WallpaperMetadataFetcher.kt +++ b/app/src/main/java/org/mozilla/fenix/wallpapers/WallpaperMetadataFetcher.kt @@ -19,7 +19,7 @@ import java.util.Locale /** * Utility class for downloading wallpaper metadata from the remote server. * - * @property client The client that will be used to fetch metadata. + * @param client The client that will be used to fetch metadata. */ class WallpaperMetadataFetcher( private val client: Client,