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

@@ -3,46 +3,64 @@
 
     # Owning object
     attr_reader :object
 
     #
-    # Creates a new InstanceParam object with the specified _object_ and
-    # _name_, and the given _description_.
+    # Creates a new InstanceParam object.
     #
+    # @param [Object] object
+    #   The object containing the instance variable for the instance
+    #   parameter.
+    #
+    # @param [Symbol, String] name
+    #   The name of the instance parameter.
+    #
+    # @param [String, nil] description
+    #   The description of the instance parameter.
+    #
     def initialize(object,name,description=nil)
       super(name,description)
 
       @object = object
     end
 
     #
-    # Returns the value of the instance param.
+    # @return
+    #   The value of the instance param.
     #
     def value
       @object.instance_variable_get("@#{@name}".to_sym)
     end
 
     #
     # Sets the value of the instance param.
     #
+    # @param [Object] value
+    #   The new value of the instance param.
+    #
+    # @return [Object]
+    #   The new value of the instance param.
+    #
     def value=(value)
       @object.instance_variable_set("@#{@name}".to_sym,value)
     end
 
     #
-    # Returns a String representation of the instance param.
+    # @return [String]
+    #   Representation of the instance param.
     #
     def to_s
-      text = "  #{@name}"
+      text = @name.to_s
 
       text << " [#{value.inspect}]" if value
-      text << "\t\t#{@description}" if @description
+      text << "\t#{@description}" if @description
 
       return text
     end
 
     #
-    # Inspects the instance params value.
+    # @return [String]
+    #   Inspection of the instance params value.
     #
     def inspect
       value.inspect
     end