Skip to content

Commit cd7c432

Browse files
committed
fix(clients): escape char in comments (#3973) (generated) [skip ci]
Co-authored-by: Pierre Millot <[email protected]>
1 parent 162dfaf commit cd7c432

File tree

225 files changed

+715
-724
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

225 files changed

+715
-724
lines changed

clients/algoliasearch-client-csharp/algoliasearch/Models/Abtesting/ABTestResponse.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public ABTestResponse() { }
2626
/// </summary>
2727
/// <param name="index">Index name of the A/B test variant (case-sensitive). (required).</param>
2828
/// <param name="abTestID">Unique A/B test identifier. (required).</param>
29-
/// <param name="taskID">Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task&#39;s progress with the [&#x60;task&#x60; operation](#tag/Indices/operation/getTask) and this &#x60;taskID&#x60;. (required).</param>
29+
/// <param name="taskID">Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`. (required).</param>
3030
public ABTestResponse(string index, int abTestID, long taskID)
3131
{
3232
Index = index ?? throw new ArgumentNullException(nameof(index));

clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyAddToCartRates.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ public DailyAddToCartRates() { }
2424
/// <summary>
2525
/// Initializes a new instance of the DailyAddToCartRates class.
2626
/// </summary>
27-
/// <param name="rate">Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
28-
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the &#x60;clickAnalytics&#x60; parameter is true. (required) (default to 0).</param>
27+
/// <param name="rate">Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. (required).</param>
28+
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0).</param>
2929
/// <param name="addToCartCount">Number of add-to-cart events from this search. (required) (default to 0).</param>
3030
/// <param name="date">Date in the format YYYY-MM-DD. (required).</param>
3131
public DailyAddToCartRates(double? rate, int trackedSearchCount, int addToCartCount, string date)

clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyAverageClicks.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public DailyAverageClicks() { }
2424
/// <summary>
2525
/// Initializes a new instance of the DailyAverageClicks class.
2626
/// </summary>
27-
/// <param name="average">Average position of a clicked search result in the list of search results. If null, Algolia didn&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
27+
/// <param name="average">Average position of a clicked search result in the list of search results. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. (required).</param>
2828
/// <param name="clickCount">Number of clicks associated with this search. (required) (default to 0).</param>
2929
/// <param name="date">Date in the format YYYY-MM-DD. (required).</param>
3030
public DailyAverageClicks(double? average, int clickCount, string date)

clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyClickThroughRates.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ public DailyClickThroughRates() { }
2424
/// <summary>
2525
/// Initializes a new instance of the DailyClickThroughRates class.
2626
/// </summary>
27-
/// <param name="rate">Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
27+
/// <param name="rate">Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. (required).</param>
2828
/// <param name="clickCount">Number of clicks associated with this search. (required) (default to 0).</param>
29-
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the &#x60;clickAnalytics&#x60; parameter is true. (required) (default to 0).</param>
29+
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0).</param>
3030
/// <param name="date">Date in the format YYYY-MM-DD. (required).</param>
3131
public DailyClickThroughRates(double? rate, int clickCount, int trackedSearchCount, string date)
3232
{

clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyConversionRates.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ public DailyConversionRates() { }
2424
/// <summary>
2525
/// Initializes a new instance of the DailyConversionRates class.
2626
/// </summary>
27-
/// <param name="rate">Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
28-
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the &#x60;clickAnalytics&#x60; parameter is true. (required) (default to 0).</param>
27+
/// <param name="rate">Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. (required).</param>
28+
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0).</param>
2929
/// <param name="conversionCount">Number of conversions from this search. (required) (default to 0).</param>
3030
/// <param name="date">Date in the format YYYY-MM-DD. (required).</param>
3131
public DailyConversionRates(double? rate, int trackedSearchCount, int conversionCount, string date)

clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyNoClickRates.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ public DailyNoClickRates() { }
2525
/// Initializes a new instance of the DailyNoClickRates class.
2626
/// </summary>
2727
/// <param name="rate">No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches. (required).</param>
28-
/// <param name="count">Number of tracked searches. Tracked searches are search requests where the &#x60;clickAnalytics&#x60; parameter is true. (required) (default to 0).</param>
28+
/// <param name="count">Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0).</param>
2929
/// <param name="noClickCount">Number of times this search was returned as a result without any click. (required).</param>
3030
/// <param name="date">Date in the format YYYY-MM-DD. (required).</param>
3131
public DailyNoClickRates(double rate, int count, int noClickCount, string date)

clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyPurchaseRates.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ public DailyPurchaseRates() { }
2424
/// <summary>
2525
/// Initializes a new instance of the DailyPurchaseRates class.
2626
/// </summary>
27-
/// <param name="rate">Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
28-
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the &#x60;clickAnalytics&#x60; parameter is true. (required) (default to 0).</param>
27+
/// <param name="rate">Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. (required).</param>
28+
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0).</param>
2929
/// <param name="purchaseCount">Number of purchase events from this search. (required) (default to 0).</param>
3030
/// <param name="date">Date in the format YYYY-MM-DD. (required).</param>
3131
public DailyPurchaseRates(double? rate, int trackedSearchCount, int purchaseCount, string date)

clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetAddToCartRateResponse.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ public GetAddToCartRateResponse() { }
2424
/// <summary>
2525
/// Initializes a new instance of the GetAddToCartRateResponse class.
2626
/// </summary>
27-
/// <param name="rate">Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
28-
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the &#x60;clickAnalytics&#x60; parameter is true. (required) (default to 0).</param>
27+
/// <param name="rate">Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. (required).</param>
28+
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0).</param>
2929
/// <param name="addToCartCount">Number of add-to-cart events from this search. (required) (default to 0).</param>
3030
/// <param name="dates">Daily add-to-cart rates. (required).</param>
3131
public GetAddToCartRateResponse(double? rate, int trackedSearchCount, int addToCartCount, List<DailyAddToCartRates> dates)

clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetAverageClickPositionResponse.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public GetAverageClickPositionResponse() { }
2424
/// <summary>
2525
/// Initializes a new instance of the GetAverageClickPositionResponse class.
2626
/// </summary>
27-
/// <param name="average">Average position of a clicked search result in the list of search results. If null, Algolia didn&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
27+
/// <param name="average">Average position of a clicked search result in the list of search results. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. (required).</param>
2828
/// <param name="clickCount">Number of clicks associated with this search. (required) (default to 0).</param>
2929
/// <param name="dates">Daily average click positions. (required).</param>
3030
public GetAverageClickPositionResponse(double? average, int clickCount, List<DailyAverageClicks> dates)

clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetClickThroughRateResponse.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ public GetClickThroughRateResponse() { }
2424
/// <summary>
2525
/// Initializes a new instance of the GetClickThroughRateResponse class.
2626
/// </summary>
27-
/// <param name="rate">Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
27+
/// <param name="rate">Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. (required).</param>
2828
/// <param name="clickCount">Number of clicks associated with this search. (required) (default to 0).</param>
29-
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the &#x60;clickAnalytics&#x60; parameter is true. (required) (default to 0).</param>
29+
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0).</param>
3030
/// <param name="dates">Daily click-through rates. (required).</param>
3131
public GetClickThroughRateResponse(double? rate, int clickCount, int trackedSearchCount, List<DailyClickThroughRates> dates)
3232
{

clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetConversionRateResponse.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ public GetConversionRateResponse() { }
2424
/// <summary>
2525
/// Initializes a new instance of the GetConversionRateResponse class.
2626
/// </summary>
27-
/// <param name="rate">Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
28-
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the &#x60;clickAnalytics&#x60; parameter is true. (required) (default to 0).</param>
27+
/// <param name="rate">Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. (required).</param>
28+
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0).</param>
2929
/// <param name="conversionCount">Number of conversions from this search. (required) (default to 0).</param>
3030
/// <param name="dates">Daily conversion rates. (required).</param>
3131
public GetConversionRateResponse(double? rate, int trackedSearchCount, int conversionCount, List<DailyConversionRates> dates)

clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetNoClickRateResponse.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ public GetNoClickRateResponse() { }
2525
/// Initializes a new instance of the GetNoClickRateResponse class.
2626
/// </summary>
2727
/// <param name="rate">No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches. (required).</param>
28-
/// <param name="count">Number of tracked searches. Tracked searches are search requests where the &#x60;clickAnalytics&#x60; parameter is true. (required) (default to 0).</param>
28+
/// <param name="count">Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0).</param>
2929
/// <param name="noClickCount">Number of times this search was returned as a result without any click. (required).</param>
3030
/// <param name="dates">Daily no click rates. (required).</param>
3131
public GetNoClickRateResponse(double rate, int count, int noClickCount, List<DailyNoClickRates> dates)

clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetPurchaseRateResponse.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ public GetPurchaseRateResponse() { }
2424
/// <summary>
2525
/// Initializes a new instance of the GetPurchaseRateResponse class.
2626
/// </summary>
27-
/// <param name="rate">Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
28-
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the &#x60;clickAnalytics&#x60; parameter is true. (required) (default to 0).</param>
27+
/// <param name="rate">Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. (required).</param>
28+
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0).</param>
2929
/// <param name="purchaseCount">Number of purchase events from this search. (required) (default to 0).</param>
3030
/// <param name="dates">Daily purchase rates. (required).</param>
3131
public GetPurchaseRateResponse(double? rate, int trackedSearchCount, int purchaseCount, List<DailyPurchaseRates> dates)

clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetTopFiltersNoResultsResponse.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public GetTopFiltersNoResultsResponse() { }
2424
/// <summary>
2525
/// Initializes a new instance of the GetTopFiltersNoResultsResponse class.
2626
/// </summary>
27-
/// <param name="values">Filters for searches without any results. If null, the search term specified with the &#x60;search&#x60; parameter is not a search without results, or the &#x60;search&#x60; parameter is absent from the request. (required).</param>
27+
/// <param name="values">Filters for searches without any results. If null, the search term specified with the `search` parameter is not a search without results, or the `search` parameter is absent from the request. (required).</param>
2828
public GetTopFiltersNoResultsResponse(List<GetTopFiltersNoResultsValues> values)
2929
{
3030
Values = values ?? throw new ArgumentNullException(nameof(values));

clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/Operator.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,37 +25,37 @@ public enum Operator
2525
Colon = 1,
2626

2727
/// <summary>
28-
/// Enum LessThan for value: &lt;
28+
/// Enum LessThan for value: <
2929
/// </summary>
3030
[JsonPropertyName("<")]
3131
LessThan = 2,
3232

3333
/// <summary>
34-
/// Enum LessThanOrEqualTo for value: &lt;&#x3D;
34+
/// Enum LessThanOrEqualTo for value: <=
3535
/// </summary>
3636
[JsonPropertyName("<=")]
3737
LessThanOrEqualTo = 3,
3838

3939
/// <summary>
40-
/// Enum Equal for value: &#x3D;
40+
/// Enum Equal for value: =
4141
/// </summary>
4242
[JsonPropertyName("=")]
4343
Equal = 4,
4444

4545
/// <summary>
46-
/// Enum NotEqual for value: !&#x3D;
46+
/// Enum NotEqual for value: !=
4747
/// </summary>
4848
[JsonPropertyName("!=")]
4949
NotEqual = 5,
5050

5151
/// <summary>
52-
/// Enum GreaterThan for value: &gt;
52+
/// Enum GreaterThan for value: >
5353
/// </summary>
5454
[JsonPropertyName(">")]
5555
GreaterThan = 6,
5656

5757
/// <summary>
58-
/// Enum GreaterThanOrEqualTo for value: &gt;&#x3D;
58+
/// Enum GreaterThanOrEqualTo for value: >=
5959
/// </summary>
6060
[JsonPropertyName(">=")]
6161
GreaterThanOrEqualTo = 7

clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopHit.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public TopHit() { }
2424
/// <summary>
2525
/// Initializes a new instance of the TopHit class.
2626
/// </summary>
27-
/// <param name="hit">Object ID of a record that&#39;s returned as a search result. (required).</param>
27+
/// <param name="hit">Object ID of a record that's returned as a search result. (required).</param>
2828
/// <param name="count">Number of occurrences. (required).</param>
2929
public TopHit(string hit, int count)
3030
{

0 commit comments

Comments
 (0)