Skip to content

Commit aaf0804

Browse files
authored
Merge pull request appwrite#1097 from appwrite/pla-3149
chore: use swift-native doc comments
2 parents 61037c1 + 0a6f964 commit aaf0804

File tree

2 files changed

+28
-12
lines changed

2 files changed

+28
-12
lines changed

templates/apple/Sources/Services/Service.swift.twig

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,15 @@ open class {{ service.name | caseUcfirst | overrideIdentifier }}: Service {
1414
{{~ method.description | swiftComment }}
1515
///
1616
{%~ endif %}
17+
{%~ if method.parameters.all | length > 0 %}
18+
/// - Parameters:
19+
{%~ endif %}
1720
{%~ for parameter in method.parameters.all %}
18-
/// @param {{ parameter | typeName(spec) | raw}} {{ parameter.name | caseCamel }}
21+
/// - {{ parameter.name | caseCamel }}: {{ parameter | typeName(spec) | raw }}{% if not parameter.required or parameter.nullable %} (optional){% endif %}
22+
1923
{%~ endfor %}
20-
/// @throws Exception
21-
/// @return array
24+
/// - Throws: Exception if the request fails
25+
/// - Returns: {{ method | returnType(spec) | raw }}
2226
///
2327
{%~ if method.type == "webAuth" %}
2428
@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
@@ -78,11 +82,15 @@ open class {{ service.name | caseUcfirst | overrideIdentifier }}: Service {
7882
{{~ method.description | swiftComment }}
7983
///
8084
{%~ endif %}
85+
{%~ if method.parameters.all | length > 0 %}
86+
/// - Parameters:
87+
{%~ endif %}
8188
{%~ for parameter in method.parameters.all %}
82-
/// @param {{ parameter | typeName(spec) | raw}} {{ parameter.name | caseCamel }}
89+
/// - {{ parameter.name | caseCamel }}: {{ parameter | typeName(spec) | raw }}{% if not parameter.required or parameter.nullable %} (optional){% endif %}
90+
8391
{%~ endfor %}
84-
/// @throws Exception
85-
/// @return array
92+
/// - Throws: Exception if the request fails
93+
/// - Returns: {{ method | returnType(spec) | raw }}
8694
///
8795
{%~ if method.type == "webAuth" %}
8896
@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)

templates/swift/Sources/Services/Service.swift.twig

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,15 @@ open class {{ service.name | caseUcfirst | overrideIdentifier }}: Service {
1414
{{~ method.description | swiftComment }}
1515
///
1616
{%~ endif %}
17+
{%~ if method.parameters.all | length > 0 %}
18+
/// - Parameters:
19+
{%~ endif %}
1720
{%~ for parameter in method.parameters.all %}
18-
/// @param {{ parameter | typeName(spec) | raw}} {{ parameter.name | caseCamel }}
21+
/// - {{ parameter.name | caseCamel }}: {{ parameter | typeName(spec) | raw }}{% if not parameter.required or parameter.nullable %} (optional){% endif %}
22+
1923
{%~ endfor %}
20-
/// @throws Exception
21-
/// @return array
24+
/// - Throws: Exception if the request fails
25+
/// - Returns: {{ method | returnType(spec) | raw }}
2226
///
2327
open func {{ method.name | caseCamel | overrideIdentifier }}{% if method.responseModel | hasGenericType(spec) %}<T>{% endif %}(
2428
{%~ for parameter in method.parameters.all %}
@@ -75,11 +79,15 @@ open class {{ service.name | caseUcfirst | overrideIdentifier }}: Service {
7579
{{~ method.description | swiftComment }}
7680
///
7781
{%~ endif %}
82+
{%~ if method.parameters.all | length > 0 %}
83+
/// - Parameters:
84+
{%~ endif %}
7885
{%~ for parameter in method.parameters.all %}
79-
/// @param {{ parameter | typeName(spec) | raw}} {{ parameter.name | caseCamel }}
86+
/// - {{ parameter.name | caseCamel }}: {{ parameter | typeName(spec) | raw }}{% if not parameter.required or parameter.nullable %} (optional){% endif %}
87+
8088
{%~ endfor %}
81-
/// @throws Exception
82-
/// @return array
89+
/// - Throws: Exception if the request fails
90+
/// - Returns: {{ method | returnType(spec) | raw }}
8391
///
8492
open func {{ method.name | caseCamel }}(
8593
{%~ for parameter in method.parameters.all %}

0 commit comments

Comments
 (0)