Skip to content

chore: use swift-native doc comments #1097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 1, 2025
Merged

chore: use swift-native doc comments #1097

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions templates/apple/Sources/Services/Service.swift.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,15 @@ open class {{ service.name | caseUcfirst | overrideIdentifier }}: Service {
{{~ method.description | swiftComment }}
///
{%~ endif %}
{%~ if method.parameters.all | length > 0 %}
/// - Parameters:
{%~ endif %}
{%~ for parameter in method.parameters.all %}
/// @param {{ parameter | typeName(spec) | raw}} {{ parameter.name | caseCamel }}
/// - {{ parameter.name | caseCamel }}: {{ parameter | typeName(spec) | raw }}{% if not parameter.required or parameter.nullable %} (optional){% endif %}

{%~ endfor %}
/// @throws Exception
/// @return array
/// - Throws: Exception if the request fails
/// - Returns: {{ method | returnType(spec) | raw }}
///
{%~ if method.type == "webAuth" %}
@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
Expand Down Expand Up @@ -78,11 +82,15 @@ open class {{ service.name | caseUcfirst | overrideIdentifier }}: Service {
{{~ method.description | swiftComment }}
///
{%~ endif %}
{%~ if method.parameters.all | length > 0 %}
/// - Parameters:
{%~ endif %}
{%~ for parameter in method.parameters.all %}
/// @param {{ parameter | typeName(spec) | raw}} {{ parameter.name | caseCamel }}
/// - {{ parameter.name | caseCamel }}: {{ parameter | typeName(spec) | raw }}{% if not parameter.required or parameter.nullable %} (optional){% endif %}

{%~ endfor %}
/// @throws Exception
/// @return array
/// - Throws: Exception if the request fails
/// - Returns: {{ method | returnType(spec) | raw }}
///
{%~ if method.type == "webAuth" %}
@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
Expand Down
20 changes: 14 additions & 6 deletions templates/swift/Sources/Services/Service.swift.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,15 @@ open class {{ service.name | caseUcfirst | overrideIdentifier }}: Service {
{{~ method.description | swiftComment }}
///
{%~ endif %}
{%~ if method.parameters.all | length > 0 %}
/// - Parameters:
{%~ endif %}
{%~ for parameter in method.parameters.all %}
/// @param {{ parameter | typeName(spec) | raw}} {{ parameter.name | caseCamel }}
/// - {{ parameter.name | caseCamel }}: {{ parameter | typeName(spec) | raw }}{% if not parameter.required or parameter.nullable %} (optional){% endif %}

{%~ endfor %}
/// @throws Exception
/// @return array
/// - Throws: Exception if the request fails
/// - Returns: {{ method | returnType(spec) | raw }}
///
open func {{ method.name | caseCamel | overrideIdentifier }}{% if method.responseModel | hasGenericType(spec) %}<T>{% endif %}(
{%~ for parameter in method.parameters.all %}
Expand Down Expand Up @@ -75,11 +79,15 @@ open class {{ service.name | caseUcfirst | overrideIdentifier }}: Service {
{{~ method.description | swiftComment }}
///
{%~ endif %}
{%~ if method.parameters.all | length > 0 %}
/// - Parameters:
{%~ endif %}
{%~ for parameter in method.parameters.all %}
/// @param {{ parameter | typeName(spec) | raw}} {{ parameter.name | caseCamel }}
/// - {{ parameter.name | caseCamel }}: {{ parameter | typeName(spec) | raw }}{% if not parameter.required or parameter.nullable %} (optional){% endif %}

{%~ endfor %}
/// @throws Exception
/// @return array
/// - Throws: Exception if the request fails
/// - Returns: {{ method | returnType(spec) | raw }}
///
open func {{ method.name | caseCamel }}(
{%~ for parameter in method.parameters.all %}
Expand Down