Skip to content

Commit 359ab5a

Browse files
Merge pull request #540 from appwrite/fix-doc-comments
Update to fix param description being escaped
2 parents 39e71d6 + b43943b commit 359ab5a

File tree

5 files changed

+8
-8
lines changed

5 files changed

+8
-8
lines changed

specs/swagger2-latest-console.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

templates/android/library/src/main/java/io/appwrite/services/ServiceTemplate.kt.twig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ class {{ service.name | caseUcfirst }} : Service {
3939
*
4040
{% endif %}
4141
{% for parameter in method.parameters.all %}
42-
* @param {{ parameter.name | caseCamel }} {{ parameter.description }}
42+
* @param {{ parameter.name | caseCamel }} {{ parameter.description | raw }}
4343
{% endfor %}
4444
* {% if method.type != "webAuth" %}@return [{{ _self.resultType(sdk.namespace, method) }}]{% endif %}
4545

templates/kotlin/src/main/kotlin/io/appwrite/services/ServiceTemplate.kt.twig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class {{ service.name | caseUcfirst }} : Service {
2828
*
2929
{% endif %}
3030
{% for parameter in method.parameters.all %}
31-
* @param {{ parameter.name | caseCamel }} {{ parameter.description }}
31+
* @param {{ parameter.name | caseCamel }} {{ parameter.description | raw }}
3232
{% endfor %}
3333
* {% if method.type != "webAuth" %}@return [{{ utils.resultType(sdk.namespace, method) }}]{% endif %}
3434

templates/php/docs/service.md.twig

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,22 @@
1818
| --- | --- | --- | --- |
1919
{% if method.parameters.path | length > 0 %}
2020
{% for parameter in method.parameters.path %}
21-
| {{ parameter.name }} | {{ parameter.type }} | {% if parameter.required == 1 %}**Required** {% endif %}{{ parameter.description }} | {{ parameter.default }} |
21+
| {{ parameter.name }} | {{ parameter.type }} | {% if parameter.required == 1 %}**Required** {% endif %}{{ parameter.description | raw }} | {{ parameter.default }} |
2222
{% endfor %}
2323
{% endif %}
2424
{% if method.parameters.query | length > 0 %}
2525
{% for parameter in method.parameters.query %}
26-
| {{ parameter.name }} | {{ parameter.type }} | {% if parameter.required == 1 %}**Required** {% endif %}{{ parameter.description }} | {{ parameter.default }} |
26+
| {{ parameter.name }} | {{ parameter.type }} | {% if parameter.required == 1 %}**Required** {% endif %}{{ parameter.description | raw }} | {{ parameter.default }} |
2727
{% endfor %}
2828
{% endif %}
2929
{% if method.parameters.body | length > 0 %}
3030
{% for parameter in method.parameters.body %}
31-
| {{ parameter.name }} | {{ parameter.type }} | {{ parameter.description }} | {{ parameter.default }} |
31+
| {{ parameter.name }} | {{ parameter.type }} | {{ parameter.description | raw }} | {{ parameter.default }} |
3232
{% endfor %}
3333
{% endif %}
3434
{% if method.parameters.formData | length > 0 %}
3535
{% for parameter in method.parameters.formData %}
36-
| {{ parameter.name }} | {{ parameter.type }} | {{ parameter.description }} | {{ parameter.default }} |
36+
| {{ parameter.name }} | {{ parameter.type }} | {{ parameter.description | raw }} | {{ parameter.default }} |
3737
{% endfor %}
3838
{% endif %}
3939

templates/ruby/lib/container/services/service.rb.twig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ module {{spec.title | caseUcfirst}}
1111
{{ method.description | rubyComment }}
1212
#
1313
{% for parameter in method.parameters.all %}
14-
# @param [{{ parameter | typeName }}] {{ parameter.name | caseSnake | escapeKeyword }} {{ parameter.description }}
14+
# @param [{{ parameter | typeName }}] {{ parameter.name | caseSnake | escapeKeyword }} {{ parameter.description | raw }}
1515
{% endfor %}
1616
#
1717
# @return [{{ method.responseModel | caseUcfirst }}]

0 commit comments

Comments
 (0)