vedeu 0.3.4 → 0.3.5

data/lib/vedeu/application.rb

@@ -3,29 +3,29 @@ module Vedeu
   # Orchestrates the running of the main application loop.
   #
   # @api private
+  #
   class Application
 
     class << self
 
-      # @return []
+      # @return [void]
       def start(configuration)
         new(configuration).start
       end
       alias_method :restart, :start
 
       # Stops the application!
-      # - The `:cleanup` event is triggered. Vedeu does not handle this event;
-      #   the client application may treat this event as Vedeu signalling that it
-      #   is about to terminate. Client applications are encouraged to use this
-      #   event to close any open buffers, save files, empty trash, etc.
+      # - The `:_cleanup_` event is triggered, which in turn triggers the client
+      #   event `:cleanup`; the client application may treat this event as Vedeu
+      #   signalling that it is about to terminate. Client applications are
+      #   encouraged to use this event to close any open buffers, save files,
+      #   empty trash, etc.
       #
-      # @raise [StopIteration] Will cause {#start} to exit its loop and
-      #   terminate the application.
-      # @return [StopIteration]
+      # @return [void]
       def stop
-        Vedeu.trigger(:cleanup)
+        Vedeu.trigger(:_cleanup_)
 
-        fail StopIteration
+        Vedeu::MainLoop.stop!
       end
 
     end # Application eigenclass
@@ -49,7 +49,7 @@ module Vedeu
     #
     # @return [Array] The last output sent to the terminal.
     def start
-      distributed_start
+      Vedeu.trigger(:_drb_start_)
 
       output = Terminal.open do
         Terminal.set_cursor_mode
@@ -59,7 +59,7 @@ module Vedeu
         runner { main_sequence }
       end
 
-      distributed_stop
+      Vedeu.trigger(:_drb_stop_, 'via Vedeu::Application#start')
 
       output
     end
@@ -71,7 +71,7 @@ module Vedeu
     # Runs the application loop either once, or forever (exceptions and signals
     # permitting).
     #
-    # @return []
+    # @return [void]
     def runner
       if configuration.once?
         yield
@@ -89,7 +89,7 @@ module Vedeu
     # and 'do something useful'. When the client application has finished, it
     # should trigger the `:_exit_` event.
     #
-    # @return []
+    # @return [void]
     def main_sequence
       if configuration.interactive?
         Input.capture(Terminal)
@@ -104,38 +104,19 @@ module Vedeu
     # uncaught exception occurs or when either the `:_mode_switch_` or `:_exit_`
     # event is triggered.
     #
-    # @return []
+    # @return [void]
     def run_many
-      loop do
-        Vedeu.trigger(:_tick_)
-        yield
-
-      end
+      MainLoop.start! { yield }
 
     rescue ModeSwitch
       Terminal.switch_mode!
 
-      distributed_stop
+      Vedeu.trigger(:_drb_restart_)
 
       Application.restart
 
     end
 
-    # @return []
-    def distributed_start
-      distributed.start if configuration.drb?
-    end
-
-    # @return []
-    def distributed_stop
-      distributed.stop if configuration.drb?
-    end
-
-    # @return [Vedeu::Distributed::Application]
-    def distributed
-      @distributed ||= Vedeu::Distributed::Application.new(configuration)
-    end
-
     # :nocov:
 
   end # Application

data/lib/vedeu/bindings.rb

@@ -17,41 +17,111 @@ module Vedeu
   #   underscore, it's probably used by Vedeu internally.
   #
   # :nocov:
+  #
   module Bindings
 
-    # System events needed by Vedeu to run.
-    Vedeu.bind(:_clear_)                   { Vedeu::Terminal.clear        }
+    # Clears the whole terminal space.
+    Vedeu.bind(:_clear_) { Vedeu::Terminal.clear }
+
+    # Vedeu triggers this event when `:_exit_` is triggered. You can hook into
+    # this to perform a special action before the application terminates. Saving
+    # the user's work, session or preferences might be popular here.
+    Vedeu.bind(:_cleanup_) do
+      Vedeu.trigger(:_drb_stop_, 'via :cleanup')
+      Vedeu.trigger(:cleanup)
+    end
+
+    Vedeu.bind(:_drb_input_) do |data|
+      Vedeu.log(type: :drb, message: 'Sending input')
+      Vedeu.trigger(:_keypress_, data)
+    end
+
+    Vedeu.bind(:_drb_retrieve_output_)  do
+      Vedeu.log(type: :drb, message: 'Retrieving output')
+      Vedeu::VirtualBuffer.retrieve
+    end
+
+    Vedeu.bind(:_drb_store_output_)  do |data|
+      Vedeu.log(type: :drb, message: 'Storing output')
+      Vedeu::VirtualBuffer.store(Vedeu::Terminal.virtual.output(data))
+    end
+
+    Vedeu.bind(:_drb_restart_) do
+      Vedeu.log(type: :drb, message: 'Attempting to restart')
+      Vedeu::Distributed::Server.restart
+    end
+
+    Vedeu.bind(:_drb_start_)   do
+      Vedeu.log(type: :drb, message: 'Attempting to start')
+      Vedeu::Distributed::Server.start
+    end
+
+    Vedeu.bind(:_drb_status_)  do
+      Vedeu.log(type: :drb, message: 'Fetching status')
+      Vedeu::Distributed::Server.status
+    end
+
+    Vedeu.bind(:_drb_stop_) do |message|
+      Vedeu.log(type: :drb, message: "Attempting to stop (#{message})")
+      Vedeu::Distributed::Server.stop
+    end
+
+    # When triggered, Vedeu will trigger a `:cleanup` event which you can define
+    # (to save files, etc) and attempt to exit.
     Vedeu.bind(:_exit_)                    { Vedeu::Application.stop      }
+
+    # Vedeu triggers this event when it is ready to enter the main loop. Client
+    # applications can listen for this event and perform some action(s), like
+    # render the first screen, interface or make a sound. When Vedeu triggers
+    # this event, the :_refresh_ event is also triggered automatically.
     Vedeu.bind(:_initialize_)              { Vedeu.trigger(:_refresh_)    }
-    Vedeu.bind(:_keypress_)                { |key| Vedeu.keypress(key)    }
-    Vedeu.bind(:_log_)                     { |msg| Vedeu.log(msg)         }
-    Vedeu.bind(:_mode_switch_)             { fail ModeSwitch              }
-    Vedeu.bind(:_resize_, { delay: 0.25 }) { Vedeu.resize                 }
-
-    # System events which when called will update the cursor visibility
-    # accordingly for the interface in focus, or the named interface. Also
-    # includes events to move the cursor in the direction specified; these will
-    # update the cursor position according to the interface in focus.
+
+    # Triggering this event will cause the triggering of the `:key` event; which
+    # you should define to 'do things'. If the `escape` key is pressed, then
+    # `key` is triggered with the argument `:escape`, also an internal event
+    # `_mode_switch_` is triggered.
+    Vedeu.bind(:_keypress_) { |key| Vedeu.keypress(key) }
+
+    # When triggered with a message will cause Vedeu to log the message if
+    # logging is enabled in the configuration.
+    Vedeu.bind(:_log_) { |msg| Vedeu.log(type: :debug, message: msg) }
+
+    # When triggered (after the user presses `escape`), Vedeu switches from a
+    # "raw mode" terminal to a "cooked mode" terminal. The idea here being that
+    # the raw mode is for single keypress actions, whilst cooked mode allows the
+    # user to enter more elaborate commands- such as commands with arguments.
+    Vedeu.bind(:_mode_switch_) { fail ModeSwitch }
+
+    # When triggered will cause Vedeu to trigger the `:_clear_` and `:_refresh_`
+    # events. Please see those events for their behaviour.
+    Vedeu.bind(:_resize_, { delay: 0.25 }) { Vedeu.resize }
+
+    # Hide the cursor of the interface currently in focus.
     Vedeu.bind(:_cursor_hide_) do
       ToggleCursor.hide(Vedeu.cursor)
     end
 
+    # Show the cursor of the interface currently in focus.
     Vedeu.bind(:_cursor_show_) do
       ToggleCursor.show(Vedeu.cursor)
     end
 
+    # Hide the cursor of the named interface.
     Vedeu.bind(:_cursor_hide_by_name_) do |name|
       named = Vedeu.cursors.by_name(name)
 
       ToggleCursor.hide(named)
     end
 
+    # Show the cursor of the named interface.
     Vedeu.bind(:_cursor_show_by_name_) do |name|
       named = Vedeu.cursors.by_name(name)
 
       ToggleCursor.show(named)
     end
 
+    # Move the cursor down one character in the interface currently in focus.
+    # Will not exceed the border or boundary of the interface.
     Vedeu.bind(:_cursor_down_) do
       interface = Vedeu.interfaces.current
 
@@ -60,6 +130,8 @@ module Vedeu
       Refresh.by_focus
     end
 
+    # Move the cursor left one character in the interface currently in focus.
+    # Will not exceed the border or boundary of the interface.
     Vedeu.bind(:_cursor_left_) do
       interface = Vedeu.interfaces.current
 
@@ -68,6 +140,8 @@ module Vedeu
       Refresh.by_focus
     end
 
+    # Move the cursor right one character in the interface currently in focus.
+    # Will not exceed the border or boundary of the interface.
     Vedeu.bind(:_cursor_right_) do
       interface = Vedeu.interfaces.current
 
@@ -76,6 +150,8 @@ module Vedeu
       Refresh.by_focus
     end
 
+    # Move the cursor up one character in the interface currently in focus.
+    # Will not exceed the border or boundary of the interface.
     Vedeu.bind(:_cursor_up_) do
       interface = Vedeu.interfaces.current
 
@@ -84,6 +160,8 @@ module Vedeu
       Refresh.by_focus
     end
 
+    # Moves the cursor to the top left position of the interface currently in
+    # focus; respecting a border if present.
     Vedeu.bind(:_cursor_origin_) do
       interface = Vedeu.interfaces.current
 
@@ -92,27 +170,56 @@ module Vedeu
       Refresh.by_focus
     end
 
-    # System events which when called will change which interface is currently
-    # focussed. When the interface is brought into focus, its cursor position
-    # and visibility is restored.
+    # When triggered with an interface name will focus that interface and
+    # restore the cursor position and visibility.
     Vedeu.bind(:_focus_by_name_) { |name| Vedeu.focus_by_name(name) }
-    Vedeu.bind(:_focus_next_)    {        Vedeu.focus_next          }
-    Vedeu.bind(:_focus_prev_)    {        Vedeu.focus_previous      }
 
-    # System events which when called with the appropriate menu name will
-    # update the menu accordingly.
-    Vedeu.bind(:_menu_bottom_)   { |name| Vedeu.menus.find(name).bottom_item   }
-    Vedeu.bind(:_menu_current_)  { |name| Vedeu.menus.find(name).current_item  }
+    # When triggered will focus the next interface and restore the cursor
+    # position and visibility.
+    Vedeu.bind(:_focus_next_) { Vedeu.focus_next }
+
+    # When triggered will focus the previous interface and restore the cursor
+    # position and visibility.
+    Vedeu.bind(:_focus_prev_) { Vedeu.focus_previous }
+
+    # Requires target menu name as argument. Makes the last menu item the
+    # current menu item.
+    Vedeu.bind(:_menu_bottom_) { |name| Vedeu.menus.find(name).bottom_item }
+
+    # Requires target menu name as argument. Returns the current menu item.
+    Vedeu.bind(:_menu_current_) { |name| Vedeu.menus.find(name).current_item }
+
+    # Requires target menu name as argument. Deselects all menu items.
     Vedeu.bind(:_menu_deselect_) { |name| Vedeu.menus.find(name).deselect_item }
-    Vedeu.bind(:_menu_items_)    { |name| Vedeu.menus.find(name).items         }
-    Vedeu.bind(:_menu_next_)     { |name| Vedeu.menus.find(name).next_item     }
-    Vedeu.bind(:_menu_prev_)     { |name| Vedeu.menus.find(name).prev_item     }
+
+    # Requires target menu name as argument. Returns all the menu items with
+    # respective `current` or `selected` boolean indicators.
+    Vedeu.bind(:_menu_items_) { |name| Vedeu.menus.find(name).items }
+
+    # Requires target menu name as argument. Makes the next menu item the
+    # current menu item, until it reaches the last item.
+    Vedeu.bind(:_menu_next_) { |name| Vedeu.menus.find(name).next_item }
+
+    # Requires target menu name as argument. Makes the previous menu item the
+    # current menu item, until it reaches the first item.
+    Vedeu.bind(:_menu_prev_) { |name| Vedeu.menus.find(name).prev_item }
+
+    # Requires target menu name as argument. Returns the selected menu item.
     Vedeu.bind(:_menu_selected_) { |name| Vedeu.menus.find(name).selected_item }
-    Vedeu.bind(:_menu_select_)   { |name| Vedeu.menus.find(name).select_item   }
-    Vedeu.bind(:_menu_top_)      { |name| Vedeu.menus.find(name).top_item      }
-    Vedeu.bind(:_menu_view_)     { |name| Vedeu.menus.find(name).view          }
 
-    # System event to refresh all registered interfaces.
+    # Requires target menu name as argument. Makes the current menu item also
+    # the selected menu item.
+    Vedeu.bind(:_menu_select_) { |name| Vedeu.menus.find(name).select_item }
+
+    # Requires target menu name as argument. Makes the first menu item the
+    # current menu item.
+    Vedeu.bind(:_menu_top_) { |name| Vedeu.menus.find(name).top_item }
+
+    # Requires target menu name as argument. Returns a subset of the menu items;
+    # starting at the current item to the last item.
+    Vedeu.bind(:_menu_view_) { |name| Vedeu.menus.find(name).view }
+
+    # Triggering this event will cause all interfaces to refresh.
     Vedeu.bind(:_refresh_) { Vedeu::Refresh.all }
 
   end # Bindings

data/lib/vedeu/buffers/display_buffer.rb

@@ -24,6 +24,7 @@ module Vedeu
     # Store the view if it has a name. This view will be shown next time the
     # refresh event is triggered for the interface.
     #
+    # @raise [InvalidSyntax] The name is not defined.
     # @return [Interface]
     def store_deferred
       unless defined_value?(name)
@@ -44,13 +45,9 @@ module Vedeu
     # @return [Interface]
     def store_new_buffer
       if Vedeu.buffers.registered?(name)
-        Vedeu.log("Updating buffer: '#{name}'")
-
         Vedeu.buffers.find(name).add(self)
 
       else
-        Vedeu.log("Registering buffer: '#{name}'")
-
         Buffer.new(name, self).store
 
       end

data/lib/vedeu/configuration/api.rb

@@ -8,6 +8,7 @@ module Vedeu
     # options used by Vedeu to affect certain behaviours.
     #
     # @api private
+    #
     class API
 
       include Vedeu::Common
@@ -64,7 +65,7 @@ module Vedeu
       # @param value [Boolean]
       # @return [Boolean]
       def interactive!(value = true)
-        Vedeu.log("Configuration::API interactive: #{value}")
+        Vedeu.log(type: :info, message: "Configuration::API interactive: #{value}")
 
         options[:interactive] = value
       end
@@ -81,7 +82,7 @@ module Vedeu
       # @param value [Boolean]
       # @return [Boolean]
       def standalone!(value = true)
-        Vedeu.log("Configuration::API interactive: #{!value}")
+        Vedeu.log(type: :info, message: "Configuration::API interactive: #{!value}")
 
         options[:interactive] = !value
       end
@@ -99,7 +100,7 @@ module Vedeu
       # @param value [Boolean]
       # @return [Boolean]
       def run_once!(value = true)
-        Vedeu.log("Configuration::API once: #{value}")
+        Vedeu.log(type: :info, message: "Configuration::API once: #{value}")
 
         options[:once] = value
       end
@@ -115,7 +116,7 @@ module Vedeu
       # @param value [Boolean]
       # @return [Boolean]
       def drb!(value = true)
-        Vedeu.log("Configuration::API drb: #{value}")
+        Vedeu.log(type: :info, message: "Configuration::API drb: #{value}")
 
         options[:drb] = value
       end
@@ -182,7 +183,7 @@ module Vedeu
       #
       # @return [Boolean]
       def cooked!
-        Vedeu.log("Configuration::API terminal_mode: :cooked")
+        Vedeu.log(type: :info, message: "Configuration::API terminal_mode: :cooked")
 
         options[:terminal_mode] = :cooked
       end
@@ -197,7 +198,7 @@ module Vedeu
       #
       # @return [Boolean]
       def raw!
-        Vedeu.log("Configuration::API terminal_mode: :raw")
+        Vedeu.log(type: :info, message: "Configuration::API terminal_mode: :raw")
 
         options[:terminal_mode] = :raw
       end
@@ -221,12 +222,12 @@ module Vedeu
       # @return [Boolean]
       def debug!(value = true)
         if options.key?(:trace) && options[:trace] != false
-          Vedeu.log("Configuration::API debug: true")
+          Vedeu.log(type: :info, message: "Configuration::API debug: true")
 
           options[:debug] = true
 
         else
-          Vedeu.log("Configuration::API debug: #{value}")
+          Vedeu.log(type: :info, message: "Configuration::API debug: #{value}")
 
           options[:debug] = value
 
@@ -252,7 +253,7 @@ module Vedeu
       def trace!(value = true)
         options[:debug] = true if value === true
 
-        Vedeu.log("Configuration::API trace: #{value}")
+        Vedeu.log(type: :info, message: "Configuration::API trace: #{value}")
 
         options[:trace] = value
       end
@@ -273,7 +274,7 @@ module Vedeu
         fail InvalidSyntax, '`colour_mode` must be `8`, `16`, `256`, ' \
                             '`16777216`.' unless valid_colour_mode?(value)
 
-        Vedeu.log("Configuration::API colour_mode: #{value}")
+        Vedeu.log(type: :info, message: "Configuration::API colour_mode: #{value}")
 
         options[:colour_mode] = value
       end
@@ -346,7 +347,7 @@ module Vedeu
       def exit_key(value)
         return invalid_key('exit_key') unless valid_key?(value)
 
-        Vedeu.log("Configuration::API exit_key: #{value}")
+        Vedeu.log(type: :info, message: "Configuration::API exit_key: #{value}")
 
         system_keys[:exit] = value
       end
@@ -368,7 +369,7 @@ module Vedeu
       def focus_next_key(value)
         return invalid_key('exit_key') unless valid_key?(value)
 
-        Vedeu.log("Configuration::API focus_next: #{value}")
+        Vedeu.log(type: :info, message: "Configuration::API focus_next: #{value}")
 
         system_keys[:focus_next] = value
       end
@@ -390,7 +391,7 @@ module Vedeu
       def focus_prev_key(value)
         return invalid_key('exit_key') unless valid_key?(value)
 
-        Vedeu.log("Configuration::API focus_prev: #{value}")
+        Vedeu.log(type: :info, message: "Configuration::API focus_prev: #{value}")
 
         system_keys[:focus_prev] = value
       end
@@ -412,7 +413,7 @@ module Vedeu
       def mode_switch_key(value)
         return invalid_key('exit_key') unless valid_key?(value)
 
-        Vedeu.log("Configuration::API mode_switch: #{value}")
+        Vedeu.log(type: :info, message: "Configuration::API mode_switch: #{value}")
 
         system_keys[:mode_switch] = value
       end

data/lib/vedeu/configuration/cli.rb

@@ -8,6 +8,7 @@ module Vedeu
     # OptionParser into options used by Vedeu to affect certain behaviours.
     #
     # @api private
+    #
     class CLI
 
       # Configure Vedeu via command-line arguments. Options set here via
@@ -39,7 +40,7 @@ module Vedeu
 
           opts.on('-i', '--interactive',
                   'Run the application in interactive mode (default).') do
-            Vedeu.log("Configuration::CLI interactive: true")
+            Vedeu.log(type: :info, message: "Configuration::CLI interactive: true")
 
             options[:interactive] = true
           end
@@ -47,46 +48,46 @@ module Vedeu
           opts.on('-I', '--noninteractive', '--standalone',
                   'Run the application non-interactively; i.e. not requiring ' \
                   'intervention from the user.') do
-            Vedeu.log("Configuration::CLI interactive: false")
+            Vedeu.log(type: :info, message: "Configuration::CLI interactive: false")
 
             options[:interactive] = false
           end
 
           opts.on('-1', '--run-once',
                   'Run the application loop once.') do
-            Vedeu.log("Configuration::CLI once: true")
+            Vedeu.log(type: :info, message: "Configuration::CLI once: true")
 
             options[:once] = true
           end
 
           opts.on('-n', '--run-many',
                   'Run the application loop continuously (default).') do
-            Vedeu.log("Configuration::CLI once: false")
+            Vedeu.log(type: :info, message: "Configuration::CLI once: false")
 
             options[:once] = false
           end
 
           opts.on('-c', '--cooked', 'Run application in cooked mode.') do
-            Vedeu.log("Configuration::CLI terminal_mode: :cooked")
+            Vedeu.log(type: :info, message: "Configuration::CLI terminal_mode: :cooked")
 
             options[:terminal_mode] = :cooked
           end
 
           opts.on('-r', '--raw', 'Run application in raw mode (default).') do
-            Vedeu.log("Configuration::CLI terminal_mode: :raw")
+            Vedeu.log(type: :info, message: "Configuration::CLI terminal_mode: :raw")
 
             options[:terminal_mode] = :raw
           end
 
           opts.on('-d', '--debug', 'Run application with debugging on.') do
-            Vedeu.log("Configuration::CLI debug: true")
+            Vedeu.log(type: :info, message: "Configuration::CLI debug: true")
 
             options[:debug] = true
           end
 
           opts.on('-D', '--trace', 'Run application with debugging on with ' \
                                    'method and event tracing (noisy!).') do
-            Vedeu.log("Configuration::CLI trace: true")
+            Vedeu.log(type: :info, message: "Configuration::CLI trace: true")
 
             options[:debug] = true
             options[:trace] = true
@@ -96,12 +97,12 @@ module Vedeu
                   'Run application in either `8`, `16`, `256` or `16777216` ' \
                   'colour mode.') do |colours|
             if [8, 16, 256, 16777216].include?(colours)
-              Vedeu.log("Configuration::CLI colour_mode: #{colours}")
+              Vedeu.log(type: :info, message: "Configuration::CLI colour_mode: #{colours}")
 
               options[:colour_mode] = colours
 
             else
-              Vedeu.log("Configuration::CLI colour_mode: 8 (defaulted)")
+              Vedeu.log(type: :info, message: "Configuration::CLI colour_mode: 8 (defaulted)")
 
               options[:colour_mode] = 8
 
@@ -110,40 +111,40 @@ module Vedeu
 
           opts.on('-l', '--log [FILENAME]', String,
                   'Specify the path for the log file.') do |filename|
-            Vedeu.log("Configuration::CLI log: #{filename}")
+            Vedeu.log(type: :info, message: "Configuration::CLI log: #{filename}")
 
             options[:log] = filename
           end
 
           opts.on('--drb', 'Run application with DRb on.') do
-            Vedeu.log("Configuration::CLI drb: true")
+            Vedeu.log(type: :info, message: "Configuration::CLI drb: true")
 
             options[:drb] = true
           end
 
           opts.on('--drb-host', 'Set the hostname/IP for the DRb server.') do |hostname|
-            Vedeu.log("Configuration::CLI drb_host: #{hostname}")
+            Vedeu.log(type: :info, message: "Configuration::CLI drb_host: #{hostname}")
 
             #options[:drb]      = true
             options[:drb_host] = hostname
           end
 
           opts.on('--drb-port', 'Set the port for the DRb server.') do |port|
-            Vedeu.log("Configuration::CLI drb_port: #{port}")
+            Vedeu.log(type: :info, message: "Configuration::CLI drb_port: #{port}")
 
             #options[:drb]      = true
             options[:drb_port] = port
           end
 
           opts.on('--drb-height', 'Set the height for fake terminal of the DRb server.') do |height|
-            Vedeu.log("Configuration::CLI drb_height: #{height}")
+            Vedeu.log(type: :info, message: "Configuration::CLI drb_height: #{height}")
 
             #options[:drb]      = true
             options[:drb_height] = height
           end
 
           opts.on('--drb-width', 'Set the width for fake terminal of the DRb server.') do |width|
-            Vedeu.log("Configuration::CLI drb_width: #{width}")
+            Vedeu.log(type: :info, message: "Configuration::CLI drb_width: #{width}")
 
             #options[:drb]      = true
             options[:drb_width] = width

data/lib/vedeu/configuration/configuration.rb

@@ -6,6 +6,7 @@ require 'vedeu/configuration/cli'
 module Vedeu
 
   # Namespace for the API configuration and CLI configuration classes.
+  #
   module Config
   end
 
@@ -18,6 +19,7 @@ module Vedeu
   # arguments provided.
   #
   # @api private
+  #
   class Configuration
 
     include Singleton
@@ -185,7 +187,7 @@ module Vedeu
       end
 
       # @param value []
-      # @return []
+      # @return [void]
       def options=(value)
         instance.options = value
       end