Skip to content

Commit 6ca53d4

Browse files
byaruhaflmarceau
andauthored
Document FXIOS-4652 [v105] Fixing missing Parameters Documentation (mozilla-mobile#11449)
* Fixing missing Parameters Documentation * Update Client/Frontend/Home/TopSites/DataManagement/TopSitesManager.swift * Update Client/Frontend/Browser/TabMetadataManager.swift * Update LegacyWallpaperDataManager.swift * Update Client/Frontend/Home/Wallpapers/Legacy/LegacyWallpaperDataManager.swift Co-authored-by: lmarceau <lmarceau@mozilla.com>
1 parent 8231a2f commit 6ca53d4

File tree

6 files changed

+10
-7
lines changed

6 files changed

+10
-7
lines changed

Client/Frontend/Browser/TabMetadataManager.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ class TabMetadataManager {
165165
/// Update observation for Regular sites (not search term)
166166
/// if the title isEmpty we don't record because title can be overriden
167167
/// - Parameters:
168-
/// - url: Site URL from webview
168+
/// - searchData: Tab Group Data
169169
/// - title: Site title from webview can be empty for slow loading pages
170170
private func updateOpenURLOnlyState(searchData: TabGroupData, title: String?) {
171171
tabGroupData = searchData

Client/Frontend/Home/TopSites/DataManagement/TopSitesDataAdaptor.swift

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,8 @@ private extension Array where Element == Site {
216216
/// Add sponsored tiles to the top sites.
217217
/// - Parameters:
218218
/// - sponsoredTileSpaces: The number of spaces available for sponsored tiles
219+
/// - contiles: An array of Contiles a type of tiles belonging in the Shortcuts section on the Firefox home page.
220+
/// - maxNumberOfSponsoredTile: maximum number of sponsored tiles
219221
/// - sites: The top sites to add the sponsored tile to
220222
mutating func addSponsoredTiles(sponsoredTileSpaces: Int, contiles: [Contile], maxNumberOfSponsoredTile: Int) {
221223
guard maxNumberOfSponsoredTile > 0 else { return }

Client/Frontend/Home/Wallpapers/Legacy/LegacyWallpaperDataManager.swift

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,10 @@ private struct LegacyWallpaperCollection {
2828
/// region or time limited.
2929
///
3030
/// - Parameters:
31-
/// - names: An array of the names of the wallpapers included in the collection.
31+
/// - wallpaperFileNames: An array of the names of the wallpapers included in the collection.
3232
/// - type: The collection type.
33-
/// - expiryDate: An optional expiry date, on and after which the wallpapers in
34-
/// the array are no longer shown. If May 1, 2022, the collection is no
35-
/// longer visible on May 1, 2022.
33+
/// - shipDate: An optional shipping date
34+
/// - expiryDate: An optional expiry date, on and after which the wallpapers in the array are no longer shown.
3635
/// - locales: An optional set of locales used to limit the regions to which
3736
/// wallpapers in the collection are shown.
3837
init(wallpaperFileNames: [WallpaperID],

Client/Frontend/Home/Wallpapers/Legacy/Protocols/LegacyWallpaperFilePathProtocol.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ extension LegacyWallpaperFilePathProtocol {
2626
/// application's document directory.
2727
///
2828
/// - Parameter key: The key to be used as the file's containing folder
29+
/// - Parameter fileManager: The file manager to use to persist and retrieve the wallpaper.
2930
/// - Returns: A URL containing the correct path for the key.
3031
func folderPath(forKey key: String,
3132
with fileManager: FileManager = FileManager.default

Client/SiteImageHelper.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ class SiteImageHelper: SiteImageHelperProtocol {
5757

5858
/// Given a `Site`, this will fetch the type of image you're looking for while allowing you to fallback to the next `SiteImageType`.
5959
/// - Parameters:
60-
/// - url: The site to fetch an image from.
60+
/// - site: The site to fetch an image from.
6161
/// - imageType: The `SiteImageType` that will work for you.
6262
/// - shouldFallback: Allow a fallback image to be given in the case where the `SiteImageType` you specify is not available.
6363
/// - metadataProvider: Metadata provider for hero image type. Default is normally used, replaced in case of tests

RustFxA/FirefoxAccountSignInViewController.swift

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ class FirefoxAccountSignInViewController: UIViewController {
9494
/// - Parameters:
9595
/// - profile: User Profile info
9696
/// - parentType: FxASignInParentType is an enum parent page that presented this VC. Parameter used in telemetry button events.
97-
/// - parameter: deepLinkParams: URL args passed in from deep link that propagate to FxA web view
97+
/// - deepLinkParams: URL args passed in from deep link that propagate to FxA web view
9898
init(profile: Profile, parentType: FxASignInParentType, deepLinkParams: FxALaunchParams?) {
9999
self.deepLinkParams = deepLinkParams
100100
self.profile = profile
@@ -204,6 +204,7 @@ extension FirefoxAccountSignInViewController {
204204
/// - deepLinkParams: FxALaunchParams from deeplink query
205205
/// - flowType: FxAPageType is used to determine if email login, qr code login, or user settings page should be presented
206206
/// - referringPage: ReferringPage enum is used to handle telemetry events correctly for the view event and the FxA sign in tap events, need to know which route we took to get to them
207+
/// - profile:
207208
static func getSignInOrFxASettingsVC(_ deepLinkParams: FxALaunchParams? = nil, flowType: FxAPageType, referringPage: ReferringPage, profile: Profile) -> UIViewController {
208209
// Show the settings page if we have already signed in. If we haven't then show the signin page
209210
let parentType: FxASignInParentType

0 commit comments

Comments
 (0)