Skip to content

Commit 7610292

Browse files
committed
Merge pull request #1331 from qswinson/csharp_comments
Csharp comments
2 parents 727c32f + 1018ca6 commit 7610292

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

modules/swagger-codegen/src/main/resources/csharp/ApiClient.mustache

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,7 @@ namespace {{packageName}}.Client
216216
/// </summary>
217217
/// <param name="content">HTTP body (e.g. string, JSON).</param>
218218
/// <param name="type">Object type.</param>
219+
/// <param name="headers"></param>
219220
/// <returns>Object representation of the JSON string.</returns>
220221
public object Deserialize(string content, Type type, IList<Parameter> headers=null)
221222
{

modules/swagger-codegen/src/main/resources/csharp/ApiException.mustache

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ namespace {{packageName}}.Client {
2020
/// <summary>
2121
/// Initializes a new instance of the <see cref="ApiException"/> class.
2222
/// </summary>
23-
/// <param name="basePath">The base path.</param>
2423
public ApiException() {}
2524

2625
/// <summary>

modules/swagger-codegen/src/main/resources/csharp/api.mustache

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,24 @@ using {{packageName}}.Client;
99
namespace {{packageName}}.Api
1010
{
1111
{{#operations}}
12+
/// <summary>
13+
/// Represents a collection of functions to interact with the API endpoints
14+
/// </summary>
1215
public interface I{{classname}}
1316
{
1417
{{#operation}}
1518
/// <summary>
1619
/// {{summary}} {{notes}}
1720
/// </summary>
1821
{{#allParams}}/// <param name="{{paramName}}">{{description}}</param>
19-
{{/allParams}}/// <returns>{{#returnType}}{{{returnType}}}{{/returnType}}</returns>
22+
{{/allParams}}/// <returns>{{#returnType}}{{^returnContainer}}{{{returnType}}}{{/returnContainer}}{{/returnType}}</returns>
2023
{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}} {{nickname}} ({{#allParams}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}});
2124

2225
/// <summary>
2326
/// {{summary}} {{notes}}
2427
/// </summary>
2528
{{#allParams}}/// <param name="{{paramName}}">{{description}}</param>
26-
{{/allParams}}/// <returns>{{#returnType}}{{{returnType}}}{{/returnType}}</returns>
29+
{{/allParams}}/// <returns>{{#returnType}}{{^returnContainer}}{{{returnType}}}{{/returnContainer}}{{/returnType}}</returns>
2730
{{#returnType}}System.Threading.Tasks.Task<{{{returnType}}}>{{/returnType}}{{^returnType}}System.Threading.Tasks.Task{{/returnType}} {{nickname}}Async ({{#allParams}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}});
2831
{{/operation}}
2932
}
@@ -77,15 +80,15 @@ namespace {{packageName}}.Api
7780
/// <summary>
7881
/// Gets or sets the API client.
7982
/// </summary>
80-
/// <value>An instance of the ApiClient</param>
83+
/// <value>An instance of the ApiClient</value>
8184
public ApiClient ApiClient {get; set;}
8285

8386
{{#operation}}
8487
/// <summary>
8588
/// {{summary}} {{notes}}
8689
/// </summary>
8790
{{#allParams}}/// <param name="{{paramName}}">{{description}}</param>
88-
{{/allParams}}/// <returns>{{#returnType}}{{{returnType}}}{{/returnType}}</returns>
91+
{{/allParams}}/// <returns>{{#returnType}}{{^returnContainer}}{{{returnType}}}{{/returnContainer}}{{/returnType}}</returns>
8992
public {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}} {{nickname}} ({{#allParams}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}})
9093
{
9194
{{#allParams}}{{#required}}
@@ -132,7 +135,7 @@ namespace {{packageName}}.Api
132135
/// {{summary}} {{notes}}
133136
/// </summary>
134137
{{#allParams}}/// <param name="{{paramName}}">{{description}}</param>
135-
{{/allParams}}/// <returns>{{#returnType}}{{{returnType}}}{{/returnType}}</returns>
138+
{{/allParams}}/// <returns>{{#returnType}}{{^returnContainer}}{{{returnType}}}{{/returnContainer}}{{/returnType}}</returns>
136139
{{#returnType}}public async System.Threading.Tasks.Task<{{{returnType}}}>{{/returnType}}{{^returnType}}public async System.Threading.Tasks.Task{{/returnType}} {{nickname}}Async ({{#allParams}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}})
137140
{
138141
{{#allParams}}{{#required}}// verify the required parameter '{{paramName}}' is set

0 commit comments

Comments
 (0)