lib/rprogram/option.rb in rprogram-0.1.7 vs lib/rprogram/option.rb in rprogram-0.1.8

@@ -20,35 +20,40 @@
     # Creates a new Option object with. If a _block_
     # is given it will be used for the custom formating of the option. If a
     # _block_ is not given, the option will use the default_format when
     # generating the arguments.
     #
-    # @param [Hash] options Additional options.
-    # @option options [String] :flag The command-line flag to use.
+    # @param [Hash] options
+    #   Additional options.
+    #
+    # @option options [String] :flag
+    #   The command-line flag to use.
+    #
     # @option options [true, false] :equals (false)
-    #                                       Implies the option maybe
-    #                                       formated as
-    #                                       <tt>"--flag=value"</tt>.
+    #   Implies the option maybe formated as <tt>"--flag=value"</tt>.
     #
     # @option options [true, false] :multiple (false)
-    #                                         Specifies the option maybe
-    #                                         given an Array of values.
-    # @option options [String] :separator The separator to use for
-    #                                     formating multiple arguments into
-    #                                     one +String+. Cannot be used with
-    #                                     the +:multiple+ option.
+    #   Specifies the option maybe given an Array of values.
+    #
+    # @option options [String] :separator
+    #   The separator to use for formating multiple arguments into one
+    #   +String+. Cannot be used with the +:multiple+ option.
+    #
     # @option options [true, false] :sub_options (false)
-    #                                            Specifies that the option
-    #                                            contains sub-options.
+    #   Specifies that the option contains sub-options.
     #
-    # @yield [option, value] If a block is given, it will be used to format
-    #                        each value of the option.
-    # @yieldparam [Option] option The option that is being formatted.
-    # @yieldparam [String, Array] value The value to format for the
-    #                                   option. May be an Array, if multiple
-    #                                   values are allowed with the option.
+    # @yield [option, value]
+    #   If a block is given, it will be used to format each value of the
+    #   option.
     #
+    # @yieldparam [Option] option
+    #   The option that is being formatted.
+    #
+    # @yieldparam [String, Array] value
+    #   The value to format for the option. May be an Array, if multiple
+    #   values are allowed with the option.
+    #
     def initialize(options={},&block)
       @flag = options[:flag]
 
       @equals = (options[:equals] || false)
       @multiple = (options[:multiple] || false)
@@ -73,12 +78,14 @@
     end
 
     #
     # Formats the arguments for the option.
     #
-    # @param [Hash, Array, String] value The arguments to format.
+    # @param [Hash, Array, String] value
+    #   The arguments to format.
     #
-    # @return [Array] The formatted arguments of the option.
+    # @return [Array]
+    #   The formatted arguments of the option.
     #
     def arguments(value)
       return [@flag] if value == true
       return [] unless value