From 4d6dbf7d920f9231c4cb3f67b19a1015ca9327bd Mon Sep 17 00:00:00 2001 From: wing328 Date: Wed, 1 Jul 2015 15:16:28 +0800 Subject: [PATCH] show return in doc only if it has a return --- .../src/main/resources/csharp/api.mustache | 10 ++-- .../src/main/csharp/IO/Swagger/Api/PetApi.cs | 42 ++++++++-------- .../main/csharp/IO/Swagger/Api/StoreApi.cs | 10 ++-- .../src/main/csharp/IO/Swagger/Api/UserApi.cs | 50 +++++++++---------- 4 files changed, 56 insertions(+), 56 deletions(-) diff --git a/modules/swagger-codegen/src/main/resources/csharp/api.mustache b/modules/swagger-codegen/src/main/resources/csharp/api.mustache index de5083b6b22..7092f66a60c 100644 --- a/modules/swagger-codegen/src/main/resources/csharp/api.mustache +++ b/modules/swagger-codegen/src/main/resources/csharp/api.mustache @@ -17,14 +17,14 @@ namespace {{packageName}}.Api { /// {{summary}} {{notes}} /// {{#allParams}}/// {{description}} - {{/allParams}}/// {{#returnType}}{{{returnType}}}{{/returnType}} + {{/allParams}}{{#returnType}}/// {{{returnType}}}{{/returnType}} {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}} {{nickname}} ({{#allParams}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}); /// /// {{summary}} {{notes}} /// {{#allParams}}/// {{description}} - {{/allParams}}/// {{#returnType}}{{{returnType}}}{{/returnType}} + {{/allParams}}{{#returnType}}/// {{{returnType}}}{{/returnType}} {{#returnType}}Task<{{{returnType}}}>{{/returnType}}{{^returnType}}Task{{/returnType}} {{nickname}}Async ({{#allParams}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}); {{/operation}} } @@ -37,7 +37,7 @@ namespace {{packageName}}.Api { /// /// Initializes a new instance of the class. /// - /// an instance of ApiClient (optional) + /// an instance of ApiClient (optional) /// public {{classname}}(ApiClient apiClient = null) { if (apiClient == null) { // use the default one in Configuration @@ -84,7 +84,7 @@ namespace {{packageName}}.Api { /// {{summary}} {{notes}} /// {{#allParams}}/// {{description}} - {{/allParams}}/// {{#returnType}}{{{returnType}}}{{/returnType}} + {{/allParams}}{{#returnType}}/// {{{returnType}}}{{/returnType}} public {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}} {{nickname}} ({{#allParams}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) { {{#allParams}}{{#required}} @@ -132,7 +132,7 @@ namespace {{packageName}}.Api { /// {{summary}} {{notes}} /// {{#allParams}}/// {{description}} - {{/allParams}}/// {{#returnType}}{{{returnType}}}{{/returnType}} + {{/allParams}}{{#returnType}}/// {{{returnType}}}{{/returnType}} public async {{#returnType}}Task<{{{returnType}}}>{{/returnType}}{{^returnType}}Task{{/returnType}} {{nickname}}Async ({{#allParams}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) { {{#allParams}}{{#required}} diff --git a/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/PetApi.cs b/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/PetApi.cs index db51ab1f753..2974cb6932b 100644 --- a/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/PetApi.cs +++ b/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/PetApi.cs @@ -15,28 +15,28 @@ namespace IO.Swagger.Api { /// Update an existing pet /// /// Pet object that needs to be added to the store - /// + void UpdatePet (Pet body); /// /// Update an existing pet /// /// Pet object that needs to be added to the store - /// + Task UpdatePetAsync (Pet body); /// /// Add a new pet to the store /// /// Pet object that needs to be added to the store - /// + void AddPet (Pet body); /// /// Add a new pet to the store /// /// Pet object that needs to be added to the store - /// + Task AddPetAsync (Pet body); /// @@ -87,7 +87,7 @@ namespace IO.Swagger.Api { /// ID of pet that needs to be updated /// Updated name of the pet /// Updated status of the pet - /// + void UpdatePetWithForm (string petId, string name, string status); /// @@ -96,7 +96,7 @@ namespace IO.Swagger.Api { /// ID of pet that needs to be updated /// Updated name of the pet /// Updated status of the pet - /// + Task UpdatePetWithFormAsync (string petId, string name, string status); /// @@ -104,7 +104,7 @@ namespace IO.Swagger.Api { /// /// /// Pet id to delete - /// + void DeletePet (string apiKey, long? petId); /// @@ -112,7 +112,7 @@ namespace IO.Swagger.Api { /// /// /// Pet id to delete - /// + Task DeletePetAsync (string apiKey, long? petId); /// @@ -121,7 +121,7 @@ namespace IO.Swagger.Api { /// ID of pet to update /// Additional data to pass to server /// file to upload - /// + void UploadFile (long? petId, string additionalMetadata, String file); /// @@ -130,7 +130,7 @@ namespace IO.Swagger.Api { /// ID of pet to update /// Additional data to pass to server /// file to upload - /// + Task UploadFileAsync (long? petId, string additionalMetadata, String file); } @@ -143,7 +143,7 @@ namespace IO.Swagger.Api { /// /// Initializes a new instance of the class. /// - /// an instance of ApiClient (optional) + /// an instance of ApiClient (optional) /// public PetApi(ApiClient apiClient = null) { if (apiClient == null) { // use the default one in Configuration @@ -190,7 +190,7 @@ namespace IO.Swagger.Api { /// Update an existing pet /// /// Pet object that needs to be added to the store - /// + public void UpdatePet (Pet body) { @@ -228,7 +228,7 @@ namespace IO.Swagger.Api { /// Update an existing pet /// /// Pet object that needs to be added to the store - /// + public async Task UpdatePetAsync (Pet body) { @@ -265,7 +265,7 @@ namespace IO.Swagger.Api { /// Add a new pet to the store /// /// Pet object that needs to be added to the store - /// + public void AddPet (Pet body) { @@ -303,7 +303,7 @@ namespace IO.Swagger.Api { /// Add a new pet to the store /// /// Pet object that needs to be added to the store - /// + public async Task AddPetAsync (Pet body) { @@ -579,7 +579,7 @@ namespace IO.Swagger.Api { /// ID of pet that needs to be updated /// Updated name of the pet /// Updated status of the pet - /// + public void UpdatePetWithForm (string petId, string name, string status) { @@ -624,7 +624,7 @@ namespace IO.Swagger.Api { /// ID of pet that needs to be updated /// Updated name of the pet /// Updated status of the pet - /// + public async Task UpdatePetWithFormAsync (string petId, string name, string status) { @@ -667,7 +667,7 @@ namespace IO.Swagger.Api { /// /// /// Pet id to delete - /// + public void DeletePet (string apiKey, long? petId) { @@ -710,7 +710,7 @@ namespace IO.Swagger.Api { /// /// /// Pet id to delete - /// + public async Task DeletePetAsync (string apiKey, long? petId) { @@ -753,7 +753,7 @@ namespace IO.Swagger.Api { /// ID of pet to update /// Additional data to pass to server /// file to upload - /// + public void UploadFile (long? petId, string additionalMetadata, String file) { @@ -798,7 +798,7 @@ namespace IO.Swagger.Api { /// ID of pet to update /// Additional data to pass to server /// file to upload - /// + public async Task UploadFileAsync (long? petId, string additionalMetadata, String file) { diff --git a/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/StoreApi.cs b/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/StoreApi.cs index b7bab55ed9a..14188799013 100644 --- a/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/StoreApi.cs +++ b/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/StoreApi.cs @@ -55,14 +55,14 @@ namespace IO.Swagger.Api { /// Delete purchase order by ID For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors /// /// ID of the order that needs to be deleted - /// + void DeleteOrder (string orderId); /// /// Delete purchase order by ID For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors /// /// ID of the order that needs to be deleted - /// + Task DeleteOrderAsync (string orderId); } @@ -75,7 +75,7 @@ namespace IO.Swagger.Api { /// /// Initializes a new instance of the class. /// - /// an instance of ApiClient (optional) + /// an instance of ApiClient (optional) /// public StoreApi(ApiClient apiClient = null) { if (apiClient == null) { // use the default one in Configuration @@ -355,7 +355,7 @@ namespace IO.Swagger.Api { /// Delete purchase order by ID For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors /// /// ID of the order that needs to be deleted - /// + public void DeleteOrder (string orderId) { @@ -396,7 +396,7 @@ namespace IO.Swagger.Api { /// Delete purchase order by ID For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors /// /// ID of the order that needs to be deleted - /// + public async Task DeleteOrderAsync (string orderId) { diff --git a/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/UserApi.cs b/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/UserApi.cs index 27cd4afc92e..86549479e32 100644 --- a/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/UserApi.cs +++ b/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/UserApi.cs @@ -15,42 +15,42 @@ namespace IO.Swagger.Api { /// Create user This can only be done by the logged in user. /// /// Created user object - /// + void CreateUser (User body); /// /// Create user This can only be done by the logged in user. /// /// Created user object - /// + Task CreateUserAsync (User body); /// /// Creates list of users with given input array /// /// List of user object - /// + void CreateUsersWithArrayInput (List body); /// /// Creates list of users with given input array /// /// List of user object - /// + Task CreateUsersWithArrayInputAsync (List body); /// /// Creates list of users with given input array /// /// List of user object - /// + void CreateUsersWithListInput (List body); /// /// Creates list of users with given input array /// /// List of user object - /// + Task CreateUsersWithListInputAsync (List body); /// @@ -72,13 +72,13 @@ namespace IO.Swagger.Api { /// /// Logs out current logged in user session /// - /// + void LogoutUser (); /// /// Logs out current logged in user session /// - /// + Task LogoutUserAsync (); /// @@ -100,7 +100,7 @@ namespace IO.Swagger.Api { /// /// name that need to be deleted /// Updated user object - /// + void UpdateUser (string username, User body); /// @@ -108,21 +108,21 @@ namespace IO.Swagger.Api { /// /// name that need to be deleted /// Updated user object - /// + Task UpdateUserAsync (string username, User body); /// /// Delete user This can only be done by the logged in user. /// /// The name that needs to be deleted - /// + void DeleteUser (string username); /// /// Delete user This can only be done by the logged in user. /// /// The name that needs to be deleted - /// + Task DeleteUserAsync (string username); } @@ -135,7 +135,7 @@ namespace IO.Swagger.Api { /// /// Initializes a new instance of the class. /// - /// an instance of ApiClient (optional) + /// an instance of ApiClient (optional) /// public UserApi(ApiClient apiClient = null) { if (apiClient == null) { // use the default one in Configuration @@ -182,7 +182,7 @@ namespace IO.Swagger.Api { /// Create user This can only be done by the logged in user. /// /// Created user object - /// + public void CreateUser (User body) { @@ -220,7 +220,7 @@ namespace IO.Swagger.Api { /// Create user This can only be done by the logged in user. /// /// Created user object - /// + public async Task CreateUserAsync (User body) { @@ -257,7 +257,7 @@ namespace IO.Swagger.Api { /// Creates list of users with given input array /// /// List of user object - /// + public void CreateUsersWithArrayInput (List body) { @@ -295,7 +295,7 @@ namespace IO.Swagger.Api { /// Creates list of users with given input array /// /// List of user object - /// + public async Task CreateUsersWithArrayInputAsync (List body) { @@ -332,7 +332,7 @@ namespace IO.Swagger.Api { /// Creates list of users with given input array /// /// List of user object - /// + public void CreateUsersWithListInput (List body) { @@ -370,7 +370,7 @@ namespace IO.Swagger.Api { /// Creates list of users with given input array /// /// List of user object - /// + public async Task CreateUsersWithListInputAsync (List body) { @@ -487,7 +487,7 @@ namespace IO.Swagger.Api { /// /// Logs out current logged in user session /// - /// + public void LogoutUser () { @@ -523,7 +523,7 @@ namespace IO.Swagger.Api { /// /// Logs out current logged in user session /// - /// + public async Task LogoutUserAsync () { @@ -643,7 +643,7 @@ namespace IO.Swagger.Api { /// /// name that need to be deleted /// Updated user object - /// + public void UpdateUser (string username, User body) { @@ -686,7 +686,7 @@ namespace IO.Swagger.Api { /// /// name that need to be deleted /// Updated user object - /// + public async Task UpdateUserAsync (string username, User body) { @@ -727,7 +727,7 @@ namespace IO.Swagger.Api { /// Delete user This can only be done by the logged in user. /// /// The name that needs to be deleted - /// + public void DeleteUser (string username) { @@ -768,7 +768,7 @@ namespace IO.Swagger.Api { /// Delete user This can only be done by the logged in user. /// /// The name that needs to be deleted - /// + public async Task DeleteUserAsync (string username) {