Skip to content

Commit 162dfaf

Browse files
millotpmillotp
authored
fix(clients): escape char in comments (#3973)
1 parent 3899bf3 commit 162dfaf

File tree

19 files changed

+27
-27
lines changed

19 files changed

+27
-27
lines changed

‎templates/csharp/api.mustache

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ namespace Algolia.Search.Clients;
3535
{{/x-acl}}
3636
{{/vendorExtensions}}
3737
{{#allParams}}
38-
/// <param name="{{paramName}}">{{{description}}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param>
38+
/// <param name="{{paramName}}">{{{description}}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param>
3939
{{/allParams}}
4040
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
4141
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -58,7 +58,7 @@ namespace Algolia.Search.Clients;
5858
{{/x-acl}}
5959
{{/vendorExtensions}}
6060
{{#allParams}}
61-
/// <param name="{{paramName}}">{{{description}}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param>
61+
/// <param name="{{paramName}}">{{{description}}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param>
6262
{{/allParams}}
6363
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
6464
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>

‎templates/csharp/modelEnum.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
{{#allowableValues}}
1111
{{#enumVars}}
1212
/// <summary>
13-
/// Enum {{name}} for value: {{value}}
13+
/// Enum {{name}} for value: {{{value}}}
1414
/// </summary>
1515
{{#isString}}
1616
{{^useGenericHost}}

‎templates/csharp/modelGeneric.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@
126126
/// </summary>
127127
{{#readWriteVars}}
128128
{{#required}}
129-
/// <param name="{{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}}">{{description}}{{^description}}{{nameInCamelCase}}{{/description}}{{#required}} (required){{/required}}{{#defaultValue}} (default to {{.}}){{/defaultValue}}.</param>
129+
/// <param name="{{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}}">{{{description}}}{{^description}}{{nameInCamelCase}}{{/description}}{{#required}} (required){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}.</param>
130130
{{/required}}
131131
{{/readWriteVars}}
132132
{{#hasOnlyReadOnly}}

‎templates/csharp/snippets/method.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public class Snippet{{client}}
2121
/// </summary>
2222
public async Task SnippetFor{{client}}{{#lambda.pascalcase}}{{method}}{{/lambda.pascalcase}}{{testIndex}}()
2323
{
24-
// >SEPARATOR {{method}} {{testName}}
24+
// >SEPARATOR {{method}} {{{testName}}}
2525
// Initialize the client
2626
{{> snippets/init}}
2727

‎templates/dart/snippets/method.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
//
1010
// {{{description}}}
1111
void snippetFor{{method}}{{testIndex}}() async {
12-
// >SEPARATOR {{method}} {{testName}}
12+
// >SEPARATOR {{method}} {{{testName}}}
1313
// Initialize the client
1414
{{> snippets/init}}
1515

‎templates/go/snippets/method.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ func SnippetFor{{#lambda.titlecase}}{{method}}{{/lambda.titlecase}}Of{{#lambda.p
1515
{{{description}}}
1616
*/
1717

18-
// >SEPARATOR {{method}} {{testName}}
18+
// >SEPARATOR {{method}} {{{testName}}}
1919
// Initialize the client{{#hasRegionalHost}} with your application region, eg. {{clientPrefix}}.ALGOLIA_APPLICATION_REGION{{/hasRegionalHost}}
2020
{{> snippets/init}}
2121

‎templates/java/api.mustache

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ public class {{classname}} extends ApiClient {
133133
{{#operation}}
134134
/**
135135
* {{{notes}}}{{#allParams}}
136-
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}
136+
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}
137137
{{#vendorExtensions}}{{#x-is-generic}}* @param innerType The class held by the index, could be your custom class or {@link Object}.{{/x-is-generic}}{{/vendorExtensions}}
138138
* @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
139139
{{> api_javadoc}}
@@ -145,7 +145,7 @@ public class {{classname}} extends ApiClient {
145145
{{! This case only sets `requestOptions` as optional }}
146146
/**
147147
* {{{notes}}}{{#allParams}}
148-
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}
148+
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}
149149
{{#vendorExtensions}}{{#x-is-generic}}* @param innerType The class held by the index, could be your custom class or {@link Object}.{{/x-is-generic}}{{/vendorExtensions}}
150150
{{> api_javadoc}}
151151
public {{> return_type}} {{operationId}}({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#hasRequiredParams}}{{#hasOptionalParams}},{{/hasOptionalParams}}{{/hasRequiredParams}}{{#optionalParams}}{{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/optionalParams}}{{#vendorExtensions}}{{#x-is-generic}}, Class<T> innerType{{/x-is-generic}}{{/vendorExtensions}}) throws AlgoliaRuntimeException {
@@ -180,7 +180,7 @@ public class {{classname}} extends ApiClient {
180180
/**
181181
* (asynchronously)
182182
* {{{notes}}}{{#allParams}}
183-
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#vendorExtensions}}{{#x-is-generic}}
183+
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#vendorExtensions}}{{#x-is-generic}}
184184
* @param innerType The class held by the index, could be your custom class or {@link Object}.{{/x-is-generic}}{{/vendorExtensions}}
185185
* @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
186186
{{> api_javadoc}}
@@ -204,7 +204,7 @@ public class {{classname}} extends ApiClient {
204204
/**
205205
* (asynchronously)
206206
* {{{notes}}}{{#allParams}}
207-
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#vendorExtensions}}{{#x-is-generic}}
207+
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#vendorExtensions}}{{#x-is-generic}}
208208
* @param innerType The class held by the index, could be your custom class or {@link Object}.{{/x-is-generic}}{{/vendorExtensions}}
209209
{{> api_javadoc}}
210210
public {{> return_type_async}} {{operationId}}Async({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#hasRequiredParams}}{{#hasOptionalParams}},{{/hasOptionalParams}}{{/hasRequiredParams}}{{#optionalParams}}{{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/optionalParams}}{{#vendorExtensions}}{{#x-is-generic}}, Class<T> innerType{{/x-is-generic}}{{/vendorExtensions}}) throws AlgoliaRuntimeException {

‎templates/java/snippets/method.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ class Snippet{{client}} {
1313
//
1414
// {{{description}}}
1515
void snippetFor{{#lambda.pascalcase}}{{method}}{{/lambda.pascalcase}}{{testIndex}}() throws Exception {
16-
// >SEPARATOR {{method}} {{testName}}
16+
// >SEPARATOR {{method}} {{{testName}}}
1717
// Initialize the client
1818
{{> snippets/init}}
1919

‎templates/javascript/snippets/method.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import type { RequestOptions } from '@algolia/client-common';
1111
//
1212
// {{{description}}}
1313
export {{#isAsyncMethod}}async{{/isAsyncMethod}} function snippetFor{{#lambda.pascalcase}}{{method}}{{/lambda.pascalcase}}{{testIndex}}(): {{#isAsyncMethod}}Promise<void>{{/isAsyncMethod}}{{^isAsyncMethod}}void{{/isAsyncMethod}} {
14-
// >SEPARATOR {{method}} {{testName}}
14+
// >SEPARATOR {{method}} {{{testName}}}
1515
// Initialize the client
1616
// {{#hasRegionalHost}}Replace '{{defaultRegion}}' with your Algolia Application Region{{/hasRegionalHost}}
1717
{{> snippets/init}}

‎templates/kotlin/snippets/method.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ class Snippet{{client}} {
1212
{{#blocksRequests}}
1313
{{#snippets}}
1414
suspend fun snippetFor{{#lambda.pascalcase}}{{method}}{{/lambda.pascalcase}}{{testIndex}}() {
15-
// >SEPARATOR {{method}} {{testName}}
15+
// >SEPARATOR {{method}} {{{testName}}}
1616
// Initialize the client
1717
{{> snippets/init}}
1818

‎templates/php/model.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ use Algolia\AlgoliaSearch\Model\ModelInterface;
1616
*
1717
* @category Class
1818
{{#description}}
19-
* @description {{.}}
19+
* @description {{{.}}}
2020
{{/description}}
2121
* @package {{invokerPackage}}
2222
*/

‎templates/php/snippets/method.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class Snippet{{client}}
1919
*/
2020
public function snippetFor{{#lambda.titlecase}}{{method}}{{/lambda.titlecase}}{{testIndex}}(): void
2121
{
22-
// >SEPARATOR {{method}} {{testName}}
22+
// >SEPARATOR {{method}} {{{testName}}}
2323
// Initialize the client
2424
{{> snippets/init}}
2525

‎templates/python/snippets/method.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ def snippet_for_{{#lambda.snakecase}}{{method}}{{/lambda.snakecase}}{{testIndex}
1111

1212
{{{description}}}
1313
"""
14-
# >SEPARATOR {{method}} {{testName}}
14+
# >SEPARATOR {{method}} {{{testName}}}
1515
# Initialize the client
1616
# In an asynchronous context, you can use {{#lambda.pascalcase}}{{{client}}}{{/lambda.pascalcase}} instead, which exposes the exact same methods.
1717
{{> snippets/init}}

‎templates/ruby/api.mustache

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ module {{moduleName}}
7777

7878
{{#operation}}
7979
{{#notes}}
80-
# {{.}}
80+
# {{{.}}}
8181
{{/notes}}
8282
{{#vendorExtensions}}
8383
{{#x-acl.0}}
@@ -89,10 +89,10 @@ module {{moduleName}}
8989
{{/vendorExtensions}}
9090
{{#allParams}}
9191
{{#required}}
92-
# @param {{paramName}} [{{{dataType}}}] {{description}} (required)
92+
# @param {{paramName}} [{{{dataType}}}] {{{description}}} (required)
9393
{{/required}}
9494
{{^required}}
95-
# @param {{paramName}} [{{{dataType}}}] {{description}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
95+
# @param {{paramName}} [{{{dataType}}}] {{{description}}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
9696
{{/required}}
9797
{{/allParams}}
9898
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -153,10 +153,10 @@ module {{moduleName}}
153153
{{/vendorExtensions}}
154154
{{#allParams}}
155155
{{#required}}
156-
# @param {{paramName}} [{{{dataType}}}] {{description}} (required)
156+
# @param {{paramName}} [{{{dataType}}}] {{{description}}} (required)
157157
{{/required}}
158158
{{^required}}
159-
# @param {{paramName}} [{{{dataType}}}] {{description}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
159+
# @param {{paramName}} [{{{dataType}}}] {{{description}}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
160160
{{/required}}
161161
{{/allParams}}
162162
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

‎templates/ruby/snippets/method.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
#
1010
# {{{description}}}
1111
def snippet_for_{{#lambda.snakecase}}{{method}}{{/lambda.snakecase}}{{testIndex}}
12-
# >SEPARATOR {{method}} {{testName}}
12+
# >SEPARATOR {{method}} {{{testName}}}
1313
# Initialize the client
1414
{{> snippets/init}}
1515

‎templates/scala/enum.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ object {{classname}} {
99
{{#allowableValues}}
1010
{{#values}}
1111
case object {{#fnEnumEntry}}{{.}}{{/fnEnumEntry}} extends {{classname}} {
12-
override def toString = "{{.}}"
12+
override def toString = "{{{.}}}"
1313
}
1414
{{/values}}
1515
{{/allowableValues}}

‎templates/scala/snippets/method.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class Snippet{{client}} {
2424
* {{{description}}}
2525
*/
2626
def snippetFor{{#lambda.pascalcase}}{{client}}{{/lambda.pascalcase}}{{#lambda.pascalcase}}{{method}}{{/lambda.pascalcase}}{{testIndex}}(): Unit = {
27-
// >SEPARATOR {{method}} {{testName}}
27+
// >SEPARATOR {{method}} {{{testName}}}
2828
// Initialize the client
2929
{{> snippets/init}}
3030

‎templates/swift/model.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import Foundation
77

88
{{#description}}
99

10-
/** {{.}} */{{/description}}{{#isDeprecated}}
10+
/** {{{.}}} */{{/description}}{{#isDeprecated}}
1111
@available(*, deprecated, message: "This schema is deprecated."){{/isDeprecated}}{{#vendorExtensions.x-is-one-of-interface}}
1212
{{> modelOneOf}}{{/vendorExtensions.x-is-one-of-interface}}{{^vendorExtensions.x-is-one-of-interface}}{{#isArray}}
1313
{{> modelArray}}{{/isArray}}{{^isArray}}{{#isEnum}}

‎templates/swift/snippets/method.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ final class {{client}}Snippet {
1212
//
1313
// {{{description}}}
1414
func snippetFor{{#lambda.pascalcase}}{{method}}{{/lambda.pascalcase}}{{testIndex}}() async throws {
15-
// >SEPARATOR {{method}} {{testName}}
15+
// >SEPARATOR {{method}} {{{testName}}}
1616
// Initialize the client
1717
{{> snippets/init}}
1818

0 commit comments

Comments
 (0)