diff --git a/Sources/Recommend/Models/RecommendBanner.swift b/Sources/Recommend/Models/RecommendBanner.swift index c1df4c55..127604b1 100644 --- a/Sources/Recommend/Models/RecommendBanner.swift +++ b/Sources/Recommend/Models/RecommendBanner.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// a search banner with image and url. +/// Banner with image and link to redirect users. public struct RecommendBanner: Codable, JSONEncodable { public var image: RecommendBannerImage? public var link: RecommendBannerLink? diff --git a/Sources/Recommend/Models/RecommendBannerImage.swift b/Sources/Recommend/Models/RecommendBannerImage.swift index 1db77f35..7e7f0542 100644 --- a/Sources/Recommend/Models/RecommendBannerImage.swift +++ b/Sources/Recommend/Models/RecommendBannerImage.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// image of a search banner. +/// Image to show inside a banner. public struct RecommendBannerImage: Codable, JSONEncodable { public var urls: [RecommendBannerImageUrl]? public var title: String? diff --git a/Sources/Recommend/Models/RecommendBannerImageUrl.swift b/Sources/Recommend/Models/RecommendBannerImageUrl.swift index 83f62512..5625d9b6 100644 --- a/Sources/Recommend/Models/RecommendBannerImageUrl.swift +++ b/Sources/Recommend/Models/RecommendBannerImageUrl.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// url for a search banner image. +/// URL for an image to show inside a banner. public struct RecommendBannerImageUrl: Codable, JSONEncodable { public var url: String? diff --git a/Sources/Recommend/Models/RecommendBannerLink.swift b/Sources/Recommend/Models/RecommendBannerLink.swift index e7535b09..871ea48e 100644 --- a/Sources/Recommend/Models/RecommendBannerLink.swift +++ b/Sources/Recommend/Models/RecommendBannerLink.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// link for a banner defined in merchandising studio. +/// Link for a banner defined in the Merchandising Studio. public struct RecommendBannerLink: Codable, JSONEncodable { public var url: String? diff --git a/Sources/Recommend/Models/RecommendWidgets.swift b/Sources/Recommend/Models/RecommendWidgets.swift index 26df3469..3d1f41b1 100644 --- a/Sources/Recommend/Models/RecommendWidgets.swift +++ b/Sources/Recommend/Models/RecommendWidgets.swift @@ -6,9 +6,9 @@ import Foundation import Core #endif -/// widgets returned from any rules that are applied to the current search. +/// Widgets returned from any rules that are applied to the current search. public struct RecommendWidgets: Codable, JSONEncodable { - /// banners defined in the merchandising studio for the given search. + /// Banners defined in the Merchandising Studio for a given search. public var banners: [RecommendBanner]? public init(banners: [RecommendBanner]? = nil) { diff --git a/Sources/Search/Models/SearchBanner.swift b/Sources/Search/Models/SearchBanner.swift index fd0506cf..042dea3d 100644 --- a/Sources/Search/Models/SearchBanner.swift +++ b/Sources/Search/Models/SearchBanner.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// a search banner with image and url. +/// Banner with image and link to redirect users. public struct SearchBanner: Codable, JSONEncodable { public var image: SearchBannerImage? public var link: SearchBannerLink? diff --git a/Sources/Search/Models/SearchBannerImage.swift b/Sources/Search/Models/SearchBannerImage.swift index 27957786..deb55e45 100644 --- a/Sources/Search/Models/SearchBannerImage.swift +++ b/Sources/Search/Models/SearchBannerImage.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// image of a search banner. +/// Image to show inside a banner. public struct SearchBannerImage: Codable, JSONEncodable { public var urls: [SearchBannerImageUrl]? public var title: String? diff --git a/Sources/Search/Models/SearchBannerImageUrl.swift b/Sources/Search/Models/SearchBannerImageUrl.swift index ddb692c8..b259da3e 100644 --- a/Sources/Search/Models/SearchBannerImageUrl.swift +++ b/Sources/Search/Models/SearchBannerImageUrl.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// url for a search banner image. +/// URL for an image to show inside a banner. public struct SearchBannerImageUrl: Codable, JSONEncodable { public var url: String? diff --git a/Sources/Search/Models/SearchBannerLink.swift b/Sources/Search/Models/SearchBannerLink.swift index 9524bd4a..2662e135 100644 --- a/Sources/Search/Models/SearchBannerLink.swift +++ b/Sources/Search/Models/SearchBannerLink.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// link for a banner defined in merchandising studio. +/// Link for a banner defined in the Merchandising Studio. public struct SearchBannerLink: Codable, JSONEncodable { public var url: String? diff --git a/Sources/Search/Models/SearchWidgets.swift b/Sources/Search/Models/SearchWidgets.swift index 76e9223a..9dcecc3a 100644 --- a/Sources/Search/Models/SearchWidgets.swift +++ b/Sources/Search/Models/SearchWidgets.swift @@ -6,9 +6,9 @@ import Foundation import Core #endif -/// widgets returned from any rules that are applied to the current search. +/// Widgets returned from any rules that are applied to the current search. public struct SearchWidgets: Codable, JSONEncodable { - /// banners defined in the merchandising studio for the given search. + /// Banners defined in the Merchandising Studio for a given search. public var banners: [SearchBanner]? public init(banners: [SearchBanner]? = nil) {