lib/parameters/param.rb in parameters-0.1.7 vs lib/parameters/param.rb in parameters-0.1.8

@@ -6,11 +6,16 @@
 
     # Description of parameter
     attr_reader :description
 
     #
-    # Creates a new Param object with the specified _name_ and the given
-    # _description_.
+    # Creates a new Param object.
+    #
+    # @param [Symbol, String] name
+    #   The name of the parameter.
+    #
+    # @param [String, nil] description
+    #   The description of the parameter.
     #
     def initialize(name,description=nil)
       @name = name.to_sym
       @description = description
     end