Update method returning value comment

Author: xhh

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

@@ -12,7 +12,7 @@ module {{moduleName}}
 {{#allParams}}{{#required}}    # @param {{paramName}} {{description}}
 {{/required}}{{/allParams}}    # @param [Hash] opts the optional parameters
 {{#allParams}}{{^required}}    # @option opts [{{dataType}}] :{{paramName}} {{description}}
-{{/required}}{{/allParams}}    # @return {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}
+{{/required}}{{/allParams}}    # @return [{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}nil{{/returnType}}]
     def self.{{nickname}}({{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}opts = {})
       {{#allParams}}{{#required}}
       # verify the required parameter '{{paramName}}' is set

samples/client/petstore/ruby/lib/swagger_client/api/pet_api.rb

@@ -9,7 +9,7 @@ class PetApi
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [Pet] :body Pet object that needs to be added to the store
-    # @return void
+    # @return [nil]
     def self.update_pet(opts = {})
 
 
@@ -45,7 +45,7 @@ def self.update_pet(opts = {})
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [Pet] :body Pet object that needs to be added to the store
-    # @return void
+    # @return [nil]
     def self.add_pet(opts = {})
 
 
@@ -81,7 +81,7 @@ def self.add_pet(opts = {})
     # Multiple status values can be provided with comma seperated strings
     # @param [Hash] opts the optional parameters
     # @option opts [array[string]] :status Status values that need to be considered for filter
-    # @return array[Pet]
+    # @return [array[Pet]]
     def self.find_pets_by_status(opts = {})
 
 
@@ -118,7 +118,7 @@ def self.find_pets_by_status(opts = {})
     # Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
     # @param [Hash] opts the optional parameters
     # @option opts [array[string]] :tags Tags to filter by
-    # @return array[Pet]
+    # @return [array[Pet]]
     def self.find_pets_by_tags(opts = {})
 
 
@@ -155,7 +155,7 @@ def self.find_pets_by_tags(opts = {})
     # Returns a pet when ID < 10.  ID > 10 or nonintegers will simulate API error conditions
     # @param pet_id ID of pet that needs to be fetched
     # @param [Hash] opts the optional parameters
-    # @return Pet
+    # @return [Pet]
     def self.get_pet_by_id(pet_id, opts = {})
 
       # verify the required parameter 'pet_id' is set
@@ -196,7 +196,7 @@ def self.get_pet_by_id(pet_id, opts = {})
     # @param [Hash] opts the optional parameters
     # @option opts [string] :name Updated name of the pet
     # @option opts [string] :status Updated status of the pet
-    # @return void
+    # @return [nil]
     def self.update_pet_with_form(pet_id, opts = {})
 
       # verify the required parameter 'pet_id' is set
@@ -238,7 +238,7 @@ def self.update_pet_with_form(pet_id, opts = {})
     # @param pet_id Pet id to delete
     # @param [Hash] opts the optional parameters
     # @option opts [string] :api_key 
-    # @return void
+    # @return [nil]
     def self.delete_pet(pet_id, opts = {})
 
       # verify the required parameter 'pet_id' is set
@@ -280,7 +280,7 @@ def self.delete_pet(pet_id, opts = {})
     # @param [Hash] opts the optional parameters
     # @option opts [string] :additional_metadata Additional data to pass to server
     # @option opts [file] :file file to upload
-    # @return void
+    # @return [nil]
     def self.upload_file(pet_id, opts = {})
 
       # verify the required parameter 'pet_id' is set

samples/client/petstore/ruby/lib/swagger_client/api/store_api.rb

@@ -8,7 +8,7 @@ class StoreApi
     # Returns pet inventories by status
     # Returns a map of status codes to quantities
     # @param [Hash] opts the optional parameters
-    # @return map[string,int]
+    # @return [map[string,int]]
     def self.get_inventory(opts = {})
 
 
@@ -44,7 +44,7 @@ def self.get_inventory(opts = {})
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [Order] :body order placed for purchasing the pet
-    # @return Order
+    # @return [Order]
     def self.place_order(opts = {})
 
 
@@ -80,7 +80,7 @@ def self.place_order(opts = {})
     # For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
     # @param order_id ID of pet that needs to be fetched
     # @param [Hash] opts the optional parameters
-    # @return Order
+    # @return [Order]
     def self.get_order_by_id(order_id, opts = {})
 
       # verify the required parameter 'order_id' is set
@@ -119,7 +119,7 @@ def self.get_order_by_id(order_id, opts = {})
     # For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
     # @param order_id ID of the order that needs to be deleted
     # @param [Hash] opts the optional parameters
-    # @return void
+    # @return [nil]
     def self.delete_order(order_id, opts = {})
 
       # verify the required parameter 'order_id' is set

samples/client/petstore/ruby/lib/swagger_client/api/user_api.rb

@@ -9,7 +9,7 @@ class UserApi
     # This can only be done by the logged in user.
     # @param [Hash] opts the optional parameters
     # @option opts [User] :body Created user object
-    # @return void
+    # @return [nil]
     def self.create_user(opts = {})
 
 
@@ -45,7 +45,7 @@ def self.create_user(opts = {})
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [array[User]] :body List of user object
-    # @return void
+    # @return [nil]
     def self.create_users_with_array_input(opts = {})
 
 
@@ -81,7 +81,7 @@ def self.create_users_with_array_input(opts = {})
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [array[User]] :body List of user object
-    # @return void
+    # @return [nil]
     def self.create_users_with_list_input(opts = {})
 
 
@@ -118,7 +118,7 @@ def self.create_users_with_list_input(opts = {})
     # @param [Hash] opts the optional parameters
     # @option opts [string] :username The user name for login
     # @option opts [string] :password The password for login in clear text
-    # @return string
+    # @return [string]
     def self.login_user(opts = {})
 
 
@@ -155,7 +155,7 @@ def self.login_user(opts = {})
     # Logs out current logged in user session
     # 
     # @param [Hash] opts the optional parameters
-    # @return void
+    # @return [nil]
     def self.logout_user(opts = {})
 
 
@@ -191,7 +191,7 @@ def self.logout_user(opts = {})
     # 
     # @param username The name that needs to be fetched. Use user1 for testing. 
     # @param [Hash] opts the optional parameters
-    # @return User
+    # @return [User]
     def self.get_user_by_name(username, opts = {})
 
       # verify the required parameter 'username' is set
@@ -231,7 +231,7 @@ def self.get_user_by_name(username, opts = {})
     # @param username name that need to be deleted
     # @param [Hash] opts the optional parameters
     # @option opts [User] :body Updated user object
-    # @return void
+    # @return [nil]
     def self.update_user(username, opts = {})
 
       # verify the required parameter 'username' is set
@@ -270,7 +270,7 @@ def self.update_user(username, opts = {})
     # This can only be done by the logged in user.
     # @param username The name that needs to be deleted
     # @param [Hash] opts the optional parameters
-    # @return void
+    # @return [nil]
     def self.delete_user(username, opts = {})
 
       # verify the required parameter 'username' is set