add remarks to csharp method

Author: wing328

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

@@ -16,15 +16,21 @@ namespace {{packageName}}.Api
     {
         {{#operation}}
         /// <summary>
-        /// {{summary}} {{notes}}
+        /// {{summary}}
         /// </summary>
+        /// <remarks>
+        /// {{notes}}
+        /// </remarks>
         {{#allParams}}/// <param name="{{paramName}}">{{description}}</param>
         {{/allParams}}/// <returns>{{#returnType}}{{^returnContainer}}{{{returnType}}}{{/returnContainer}}{{/returnType}}</returns>
         {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}} {{nickname}} ({{#allParams}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}});
 
         /// <summary>
-        /// {{summary}} {{notes}}
+        /// {{summary}}
         /// </summary>
+        /// <remarks>
+        /// {{notes}}
+        /// </remarks>
         {{#allParams}}/// <param name="{{paramName}}">{{description}}</param>
         {{/allParams}}/// <returns>{{#returnType}}{{^returnContainer}}{{{returnType}}}{{/returnContainer}}{{/returnType}}</returns>
         {{#returnType}}System.Threading.Tasks.Task<{{{returnType}}}>{{/returnType}}{{^returnType}}System.Threading.Tasks.Task{{/returnType}} {{nickname}}Async ({{#allParams}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}});

samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/PetApi.cs

@@ -15,121 +15,169 @@ public interface IPetApi
     {
 
         /// <summary>
-        /// Update an existing pet 
+        /// Update an existing pet
         /// </summary>
+        /// <remarks>
+        /// 
+        /// </remarks>
         /// <param name="body">Pet object that needs to be added to the store</param>
         /// <returns></returns>
         void UpdatePet (Pet body);
 
         /// <summary>
-        /// Update an existing pet 
+        /// Update an existing pet
         /// </summary>
+        /// <remarks>
+        /// 
+        /// </remarks>
         /// <param name="body">Pet object that needs to be added to the store</param>
         /// <returns></returns>
         System.Threading.Tasks.Task UpdatePetAsync (Pet body);
 
         /// <summary>
-        /// Add a new pet to the store 
+        /// Add a new pet to the store
         /// </summary>
+        /// <remarks>
+        /// 
+        /// </remarks>
         /// <param name="body">Pet object that needs to be added to the store</param>
         /// <returns></returns>
         void AddPet (Pet body);
 
         /// <summary>
-        /// Add a new pet to the store 
+        /// Add a new pet to the store
         /// </summary>
+        /// <remarks>
+        /// 
+        /// </remarks>
         /// <param name="body">Pet object that needs to be added to the store</param>
         /// <returns></returns>
         System.Threading.Tasks.Task AddPetAsync (Pet body);
 
         /// <summary>
-        /// Finds Pets by status Multiple status values can be provided with comma seperated strings
+        /// Finds Pets by status
         /// </summary>
+        /// <remarks>
+        /// Multiple status values can be provided with comma seperated strings
+        /// </remarks>
         /// <param name="status">Status values that need to be considered for filter</param>
         /// <returns></returns>
         List<Pet> FindPetsByStatus (List<string> status);
 
         /// <summary>
-        /// Finds Pets by status Multiple status values can be provided with comma seperated strings
+        /// Finds Pets by status
         /// </summary>
+        /// <remarks>
+        /// Multiple status values can be provided with comma seperated strings
+        /// </remarks>
         /// <param name="status">Status values that need to be considered for filter</param>
         /// <returns></returns>
         System.Threading.Tasks.Task<List<Pet>> FindPetsByStatusAsync (List<string> status);
 
         /// <summary>
-        /// Finds Pets by tags Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
+        /// Finds Pets by tags
         /// </summary>
+        /// <remarks>
+        /// Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
+        /// </remarks>
         /// <param name="tags">Tags to filter by</param>
         /// <returns></returns>
         List<Pet> FindPetsByTags (List<string> tags);
 
         /// <summary>
-        /// Finds Pets by tags Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
+        /// Finds Pets by tags
         /// </summary>
+        /// <remarks>
+        /// Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
+        /// </remarks>
         /// <param name="tags">Tags to filter by</param>
         /// <returns></returns>
         System.Threading.Tasks.Task<List<Pet>> FindPetsByTagsAsync (List<string> tags);
 
         /// <summary>
-        /// Find pet by ID Returns a pet when ID &lt; 10.  ID &gt; 10 or nonintegers will simulate API error conditions
+        /// Find pet by ID
         /// </summary>
+        /// <remarks>
+        /// Returns a pet when ID &lt; 10.  ID &gt; 10 or nonintegers will simulate API error conditions
+        /// </remarks>
         /// <param name="petId">ID of pet that needs to be fetched</param>
         /// <returns>Pet</returns>
         Pet GetPetById (long? petId);
 
         /// <summary>
-        /// Find pet by ID Returns a pet when ID &lt; 10.  ID &gt; 10 or nonintegers will simulate API error conditions
+        /// Find pet by ID
         /// </summary>
+        /// <remarks>
+        /// Returns a pet when ID &lt; 10.  ID &gt; 10 or nonintegers will simulate API error conditions
+        /// </remarks>
         /// <param name="petId">ID of pet that needs to be fetched</param>
         /// <returns>Pet</returns>
         System.Threading.Tasks.Task<Pet> GetPetByIdAsync (long? petId);
 
         /// <summary>
-        /// Updates a pet in the store with form data 
+        /// Updates a pet in the store with form data
         /// </summary>
+        /// <remarks>
+        /// 
+        /// </remarks>
         /// <param name="petId">ID of pet that needs to be updated</param>
         /// <param name="name">Updated name of the pet</param>
         /// <param name="status">Updated status of the pet</param>
         /// <returns></returns>
         void UpdatePetWithForm (string petId, string name, string status);
 
         /// <summary>
-        /// Updates a pet in the store with form data 
+        /// Updates a pet in the store with form data
         /// </summary>
+        /// <remarks>
+        /// 
+        /// </remarks>
         /// <param name="petId">ID of pet that needs to be updated</param>
         /// <param name="name">Updated name of the pet</param>
         /// <param name="status">Updated status of the pet</param>
         /// <returns></returns>
         System.Threading.Tasks.Task UpdatePetWithFormAsync (string petId, string name, string status);
 
         /// <summary>
-        /// Deletes a pet 
+        /// Deletes a pet
         /// </summary>
+        /// <remarks>
+        /// 
+        /// </remarks>
         /// <param name="petId">Pet id to delete</param>
         /// <param name="apiKey"></param>
         /// <returns></returns>
         void DeletePet (long? petId, string apiKey);
 
         /// <summary>
-        /// Deletes a pet 
+        /// Deletes a pet
         /// </summary>
+        /// <remarks>
+        /// 
+        /// </remarks>
         /// <param name="petId">Pet id to delete</param>
         /// <param name="apiKey"></param>
         /// <returns></returns>
         System.Threading.Tasks.Task DeletePetAsync (long? petId, string apiKey);
 
         /// <summary>
-        /// uploads an image 
+        /// uploads an image
         /// </summary>
+        /// <remarks>
+        /// 
+        /// </remarks>
         /// <param name="petId">ID of pet to update</param>
         /// <param name="additionalMetadata">Additional data to pass to server</param>
         /// <param name="file">file to upload</param>
         /// <returns></returns>
         void UploadFile (long? petId, string additionalMetadata, Stream file);
 
         /// <summary>
-        /// uploads an image 
+        /// uploads an image
         /// </summary>
+        /// <remarks>
+        /// 
+        /// </remarks>
         /// <param name="petId">ID of pet to update</param>
         /// <param name="additionalMetadata">Additional data to pass to server</param>
         /// <param name="file">file to upload</param>

samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/StoreApi.cs

@@ -15,55 +15,79 @@ public interface IStoreApi
     {
 
         /// <summary>
-        /// Returns pet inventories by status Returns a map of status codes to quantities
+        /// Returns pet inventories by status
         /// </summary>
+        /// <remarks>
+        /// Returns a map of status codes to quantities
+        /// </remarks>
         /// <returns></returns>
         Dictionary<string, int?> GetInventory ();
 
         /// <summary>
-        /// Returns pet inventories by status Returns a map of status codes to quantities
+        /// Returns pet inventories by status
         /// </summary>
+        /// <remarks>
+        /// Returns a map of status codes to quantities
+        /// </remarks>
         /// <returns></returns>
         System.Threading.Tasks.Task<Dictionary<string, int?>> GetInventoryAsync ();
 
         /// <summary>
-        /// Place an order for a pet 
+        /// Place an order for a pet
         /// </summary>
+        /// <remarks>
+        /// 
+        /// </remarks>
         /// <param name="body">order placed for purchasing the pet</param>
         /// <returns>Order</returns>
         Order PlaceOrder (Order body);
 
         /// <summary>
-        /// Place an order for a pet 
+        /// Place an order for a pet
         /// </summary>
+        /// <remarks>
+        /// 
+        /// </remarks>
         /// <param name="body">order placed for purchasing the pet</param>
         /// <returns>Order</returns>
         System.Threading.Tasks.Task<Order> PlaceOrderAsync (Order body);
 
         /// <summary>
-        /// Find purchase order by ID For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values will generated exceptions
+        /// Find purchase order by ID
         /// </summary>
+        /// <remarks>
+        /// For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values will generated exceptions
+        /// </remarks>
         /// <param name="orderId">ID of pet that needs to be fetched</param>
         /// <returns>Order</returns>
         Order GetOrderById (string orderId);
 
         /// <summary>
-        /// Find purchase order by ID For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values will generated exceptions
+        /// Find purchase order by ID
         /// </summary>
+        /// <remarks>
+        /// For valid response try integer IDs with value &lt;= 5 or &gt; 10. Other values will generated exceptions
+        /// </remarks>
         /// <param name="orderId">ID of pet that needs to be fetched</param>
         /// <returns>Order</returns>
         System.Threading.Tasks.Task<Order> GetOrderByIdAsync (string orderId);
 
         /// <summary>
-        /// Delete purchase order by ID For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
+        /// Delete purchase order by ID
         /// </summary>
+        /// <remarks>
+        /// For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
+        /// </remarks>
         /// <param name="orderId">ID of the order that needs to be deleted</param>
         /// <returns></returns>
         void DeleteOrder (string orderId);
 
         /// <summary>
-        /// Delete purchase order by ID For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
+        /// Delete purchase order by ID
         /// </summary>
+        /// <remarks>
+        /// For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
+        /// </remarks>
         /// <param name="orderId">ID of the order that needs to be deleted</param>
         /// <returns></returns>
         System.Threading.Tasks.Task DeleteOrderAsync (string orderId);