fix(clients): escape char in comments (generated)

algolia/api-clients-automation#3973

Co-authored-by: algolia-bot <[email protected]>

Author: algolia-bot

Sources/Abtesting/Models/AbtestingStatus.swift

@@ -6,10 +6,9 @@ import Foundation
     import Core
 #endif
 
-/// A/B test status.  - `active`. The A/B test is live and search traffic is split between the two variants. -
-/// `stopped`. You stopped the A/B test. The A/B test data is still available for analysis. -
-/// `expired`. The A/B test was automatically stopped after reaching its end date. - `failed`.
-/// Creating the A/B test failed.
+/// A/B test status.  - `active`. The A/B test is live and search traffic is split between the two variants. -
+/// `stopped`. You stopped the A/B test. The A/B test data is still available for analysis. - `expired`. The A/B test
+/// was automatically stopped after reaching its end date. - `failed`. Creating the A/B test failed.
 public enum AbtestingStatus: String, Codable, CaseIterable {
     case active
     case stopped

Sources/Analytics/Models/Operator.swift

@@ -6,8 +6,8 @@ import Foundation
     import Core
 #endif
 
-/// Character that characterizes how the filter is applied.  For example, for a facet filter `facet:value`,
-/// `:` is the operator. For a numeric filter `count>50`, `>` is the operator.
+/// Character that characterizes how the filter is applied.  For example, for a facet filter `facet:value`, `:` is the
+/// operator. For a numeric filter `count>50`, `>` is the operator.
 public enum Operator: String, Codable, CaseIterable {
     case colon = ":"
     case lessThan = "<"

Sources/Analytics/Models/OrderBy.swift

@@ -6,8 +6,8 @@ import Foundation
     import Core
 #endif
 
-/// Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only
-/// `searchCount` is available.
+/// Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is
+/// available.
 public enum OrderBy: String, Codable, CaseIterable {
     case searchCount
     case clickThroughRate

Sources/Ingestion/Models/AuthenticationType.swift

@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// Type of authentication. This determines the type of credentials required in the `input` object.
+/// Type of authentication. This determines the type of credentials required in the `input` object.
 public enum AuthenticationType: String, Codable, CaseIterable {
     case googleServiceAccount
     case basic

Sources/Ingestion/Models/DestinationType.swift

@@ -6,8 +6,8 @@ import Foundation
     import Core
 #endif
 
-/// Destination type.  - `search`.   Data is stored in an Algolia index.  - `insights`.   Data is
-/// recorded as user events in the Insights API.
+/// Destination type.  - `search`.   Data is stored in an Algolia index.  - `insights`.   Data is recorded as user
+/// events in the Insights API.
 public enum DestinationType: String, Codable, CaseIterable {
     case search
     case insights

Sources/Ingestion/Models/OnDemandTriggerType.swift

@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// Task is run manually, with the `/run` endpoint.
+/// Task is run manually, with the `/run` endpoint.
 public enum OnDemandTriggerType: String, Codable, CaseIterable {
     case onDemand
 }

Sources/Ingestion/Models/RunReasonCode.swift

@@ -6,8 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// A code for the task run's outcome. A readable description of the code is included in the `reason`
-/// response property.
+/// A code for the task run's outcome. A readable description of the code is included in the `reason` response property.
 public enum RunReasonCode: String, Codable, CaseIterable {
     case `internal`
     case critical

Sources/Ingestion/Models/ShopifyInput.swift

@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// Represents the required elements of the task input when using a `shopify` source.
+/// Represents the required elements of the task input when using a `shopify` source.
 public struct ShopifyInput: Codable, JSONEncodable {
     public var metafields: [ShopifyMetafield]
     public var market: ShopifyMarket

Sources/Ingestion/Models/StreamingInput.swift

@@ -6,8 +6,8 @@ import Foundation
     import Core
 #endif
 
-/// Input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted
-/// data is continuously streamed.
+/// Input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is
+/// continuously streamed.
 public struct StreamingInput: Codable, JSONEncodable {
     public var mapping: MappingInput
 

Sources/Ingestion/Models/TaskCreateV1.swift

@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// API request body for creating a task using the V1 shape, please use methods and types that don't contain the V1
+/// API request body for creating a task using the V1 shape, please use methods and types that don't contain the V1
 /// suffix.
 @available(*, deprecated, message: "This schema is deprecated.")
 public struct TaskCreateV1: Codable, JSONEncodable {

Sources/Ingestion/Models/TaskUpdateV1.swift

@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// API request body for updating a task using the V1 shape, please use methods and types that don't contain the V1
+/// API request body for updating a task using the V1 shape, please use methods and types that don't contain the V1
 /// suffix.
 @available(*, deprecated, message: "This schema is deprecated.")
 public struct TaskUpdateV1: Codable, JSONEncodable {

Sources/Ingestion/Models/TaskV1.swift

@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// The V1 task object, please use methods and types that don't contain the V1 suffix.
+/// The V1 task object, please use methods and types that don't contain the V1 suffix.
 @available(*, deprecated, message: "This schema is deprecated.")
 public struct TaskV1: Codable, JSONEncodable {
     /// Universally unique identifier (UUID) of a task.

Sources/Ingestion/Models/TriggerType.swift

@@ -6,10 +6,9 @@ import Foundation
     import Core
 #endif
 
-/// Task trigger, describing when a task should run.  - `onDemand`.   Manually trigger the task with the
-/// `/run` endpoint.  - `schedule`.   Regularly trigger the task on a `cron` schedule.  -
-/// `subscription`.   Trigger the task after an event is received, such as, a webhook.  -
-/// `streaming`.   Run the task continuously.
+/// Task trigger, describing when a task should run.  - `onDemand`.   Manually trigger the task with the `/run`
+/// endpoint.  - `schedule`.   Regularly trigger the task on a `cron` schedule.  - `subscription`.   Trigger the task
+/// after an event is received, such as, a webhook.  - `streaming`.   Run the task continuously.
 public enum TriggerType: String, Codable, CaseIterable {
     case onDemand
     case schedule

Sources/Insights/Models/AddedToCartObjectIDs.swift

@@ -7,8 +7,8 @@ import Foundation
 #endif
 
 /// Use this event to track when users add items to their shopping cart unrelated to a previous Algolia request. For
-/// example, if you don't use Algolia to build your category pages, use this event.  To track add-to-cart events
-/// related to Algolia requests, use the \"Added to cart object IDs after search\" event.
+/// example, if you don't use Algolia to build your category pages, use this event.  To track add-to-cart events related
+/// to Algolia requests, use the \"Added to cart object IDs after search\" event.
 public struct AddedToCartObjectIDs: Codable, JSONEncodable {
     /// Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework)
     /// framework.

Sources/Insights/Models/AddedToCartObjectIDsAfterSearch.swift

@@ -6,8 +6,8 @@ import Foundation
     import Core
 #endif
 
-/// Use this event to track when users add items to their shopping cart after a previous Algolia request. If you're
-/// building your category pages with Algolia, you'll also use this event.
+/// Use this event to track when users add items to their shopping cart after a previous Algolia request. If you're
+/// building your category pages with Algolia, you'll also use this event.
 public struct AddedToCartObjectIDsAfterSearch: Codable, JSONEncodable {
     /// Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework)
     /// framework.

Sources/Insights/Models/ClickedObjectIDs.swift

@@ -6,9 +6,9 @@ import Foundation
     import Core
 #endif
 
-/// Use this event to track when users click items unrelated to a previous Algolia request. For example, if you
-/// don't use Algolia to build your category pages, use this event.  To track click events related to Algolia
-/// requests, use the \"Clicked object IDs after search\" event.
+/// Use this event to track when users click items unrelated to a previous Algolia request. For example, if you don't
+/// use Algolia to build your category pages, use this event.  To track click events related to Algolia requests, use
+/// the \"Clicked object IDs after search\" event.
 public struct ClickedObjectIDs: Codable, JSONEncodable {
     /// Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework)
     /// framework.

Sources/Insights/Models/ClickedObjectIDsAfterSearch.swift

@@ -7,7 +7,7 @@ import Foundation
 #endif
 
 /// Click event after an Algolia request.  Use this event to track when users click items in the search results. If
-/// you're building your category pages with Algolia, you'll also use this event.
+/// you're building your category pages with Algolia, you'll also use this event.
 public struct ClickedObjectIDsAfterSearch: Codable, JSONEncodable {
     /// Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework)
     /// framework.

Sources/Insights/Models/ConvertedObjectIDs.swift

@@ -7,8 +7,8 @@ import Foundation
 #endif
 
 /// Use this event to track when users convert on items unrelated to a previous Algolia request. For example, if you
-/// don't use Algolia to build your category pages, use this event.  To track conversion events related to Algolia
-/// requests, use the \"Converted object IDs after search\" event.
+/// don't use Algolia to build your category pages, use this event.  To track conversion events related to Algolia
+/// requests, use the \"Converted object IDs after search\" event.
 public struct ConvertedObjectIDs: Codable, JSONEncodable {
     /// Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework)
     /// framework.

Sources/Insights/Models/ConvertedObjectIDsAfterSearch.swift

@@ -8,7 +8,7 @@ import Foundation
 
 /// Use this event to track when users convert after a previous Algolia request. For example, a user clicks on an item
 /// in the search results to view the product detail page. Then, the user adds the item to their shopping cart.  If
-/// you're building your category pages with Algolia, you'll also use this event.
+/// you're building your category pages with Algolia, you'll also use this event.
 public struct ConvertedObjectIDsAfterSearch: Codable, JSONEncodable {
     /// Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework)
     /// framework.

Sources/Insights/Models/Discount.swift

@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// Absolute value of the discount for this product, in units of `currency`.
+/// Absolute value of the discount for this product, in units of `currency`.
 public enum Discount: Codable, JSONEncodable, AbstractEncodable {
     case double(Double)
     case string(String)

Sources/Insights/Models/InsightsValue.swift

@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// Total monetary value of this event in units of `currency`.
+/// Total monetary value of this event in units of `currency`.
 public enum InsightsValue: Codable, JSONEncodable, AbstractEncodable {
     case double(Double)
     case string(String)

Sources/Insights/Models/Price.swift

@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// Total price of a product, including any discounts, in units of `currency`.
+/// Total price of a product, including any discounts, in units of `currency`.
 public enum Price: Codable, JSONEncodable, AbstractEncodable {
     case double(Double)
     case string(String)

Sources/Insights/Models/PurchasedObjectIDs.swift

@@ -7,8 +7,8 @@ import Foundation
 #endif
 
 /// Use this event to track when users make a purchase unrelated to a previous Algolia request. For example, if you
-/// don't use Algolia to build your category pages, use this event.  To track purchase events related to Algolia
-/// requests, use the \"Purchased object IDs after search\" event.
+/// don't use Algolia to build your category pages, use this event.  To track purchase events related to Algolia
+/// requests, use the \"Purchased object IDs after search\" event.
 public struct PurchasedObjectIDs: Codable, JSONEncodable {
     /// Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework)
     /// framework.

Sources/Insights/Models/PurchasedObjectIDsAfterSearch.swift

@@ -6,8 +6,8 @@ import Foundation
     import Core
 #endif
 
-/// Use this event to track when users make a purchase after a previous Algolia request. If you're building your
-/// category pages with Algolia, you'll also use this event.
+/// Use this event to track when users make a purchase after a previous Algolia request. If you're building your
+/// category pages with Algolia, you'll also use this event.
 public struct PurchasedObjectIDsAfterSearch: Codable, JSONEncodable {
     /// Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework)
     /// framework.

Sources/QuerySuggestions/Models/ModelLogLevel.swift

@@ -6,9 +6,9 @@ import Foundation
     import Core
 #endif
 
-/// Type of log entry.  - `SKIP`. A query is skipped because it doesn't match the conditions for
-/// successful inclusion. For example, when a query doesn't generate enough search results. - `INFO`. An
-/// informative log entry. - `ERROR`. The Query Suggestions process encountered an error.
+/// Type of log entry.  - `SKIP`. A query is skipped because it doesn't match the conditions for successful inclusion.
+/// For example, when a query doesn't generate enough search results. - `INFO`. An informative log entry. - `ERROR`. The
+/// Query Suggestions process encountered an error.
 public enum ModelLogLevel: String, Codable, CaseIterable {
     case skip = "SKIP"
     case info = "INFO"

Sources/Recommend/Models/FbtModel.swift

@@ -7,7 +7,7 @@ import Foundation
 #endif
 
 /// Frequently bought together model.  This model recommends items that have been purchased within 1 day with the item
-/// with the ID `objectID`.
+/// with the ID `objectID`.
 public enum FbtModel: String, Codable, CaseIterable {
     case boughtTogether = "bought-together"
 }

Sources/Recommend/Models/LookingSimilarModel.swift

@@ -6,8 +6,8 @@ import Foundation
     import Core
 #endif
 
-/// Looking similar model.  This model recommends items that look similar to the item with the ID `objectID`
-/// based on image attributes in your index.
+/// Looking similar model.  This model recommends items that look similar to the item with the ID `objectID` based on
+/// image attributes in your index.
 public enum LookingSimilarModel: String, Codable, CaseIterable {
     case lookingSimilar = "looking-similar"
 }

Sources/Recommend/Models/RecommendAroundRadius.swift

@@ -6,10 +6,10 @@ import Foundation
     import Core
 #endif
 
-/// Maximum radius for a search around a central location.  This parameter works in combination with the
-/// `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined
-/// automatically from the density of hits around the central location. The search radius is small if there are many
-/// hits close to the central coordinates.
+/// Maximum radius for a search around a central location.  This parameter works in combination with the `aroundLatLng`
+/// and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of
+/// hits around the central location. The search radius is small if there are many hits close to the central
+/// coordinates.
 public enum RecommendAroundRadius: Codable, JSONEncodable, AbstractEncodable {
     case int(Int)
     case recommendAroundRadiusAll(RecommendAroundRadiusAll)

Sources/Recommend/Models/RecommendAroundRadiusAll.swift

@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// Return all records with a valid `_geoloc` attribute. Don't filter by distance.
+/// Return all records with a valid `_geoloc` attribute. Don't filter by distance.
 public enum RecommendAroundRadiusAll: String, Codable, CaseIterable {
     case all
 }

Sources/Recommend/Models/RecommendDistinct.swift

@@ -7,9 +7,9 @@ import Foundation
 #endif
 
 /// Determines how many records of a group are included in the search results.  Records with the same value for the
-/// `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how
-/// many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).
-///  The `distinct` setting is ignored if `attributeForDistinct` is not set.
+/// `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the
+/// group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).
+///  The `distinct` setting is ignored if `attributeForDistinct` is not set.
 public enum RecommendDistinct: Codable, JSONEncodable, AbstractEncodable {
     case bool(Bool)
     case int(Int)

Sources/Recommend/Models/RecommendExactOnSingleWordQuery.swift

@@ -7,12 +7,12 @@ import Foundation
 #endif
 
 /// Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes)
-/// is computed when the search query has only one word.  - `attribute`.   The Exact ranking criterion is 1 if
-/// the query word and attribute value are the same.   For example, a search for \"road\" will match the value
-/// \"road\", but not \"road trip\".  - `none`.   The Exact ranking criterion is ignored
-/// on single-word searches.  - `word`.   The Exact ranking criterion is 1 if the query word is found in the
-/// attribute value.   The query word must have at least 3 characters and must not be a stop word.   Only exact matches
-/// will be highlighted,   partial and prefix matches won't.
+/// is computed when the search query has only one word.  - `attribute`.   The Exact ranking criterion is 1 if the query
+/// word and attribute value are the same.   For example, a search for \"road\" will match the value \"road\", but not
+/// \"road trip\".  - `none`.   The Exact ranking criterion is ignored on single-word searches.  - `word`.   The Exact
+/// ranking criterion is 1 if the query word is found in the attribute value.   The query word must have at least 3
+/// characters and must not be a stop word.   Only exact matches will be highlighted,   partial and prefix matches
+/// won't.
 public enum RecommendExactOnSingleWordQuery: String, Codable, CaseIterable {
     case attribute
     case `none`