system.rb in vedeu-0.6.9

- old
+ new

@@ -1,18 +1,15 @@
 module Vedeu
 
   module Bindings
 
-    # Creates system events which when called provide a variety of core
-    # functions and behaviours. They are soft-namespaced using underscores.
-    #
-    # :nocov:
     module System
 
       extend self
 
-      # Setup events relating to running Vedeu. This method is called by Vedeu.
+      # Setup events relating to running Vedeu. This method is called
+      # by Vedeu.
       #
       # @return [TrueClass]
       def setup!
         cleanup!
         clear!
@@ -28,34 +25,19 @@
         unmaximise!
       end
 
       private
 
-      # 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.
-      #
-      # @example
-      #   Vedeu.trigger(:_exit_)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_cleanup_}
       def cleanup!
         Vedeu.bind(:_cleanup_) do
           Vedeu.trigger(:_drb_stop_)
           Vedeu.trigger(:cleanup)
         end
       end
 
-      # Clears the whole terminal space, or when a name is given, the named
-      # interface area will be cleared.
-      #
-      # @example
-      #   Vedeu.trigger(:_clear_)
-      #   Vedeu.clear_by_name(name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_cleanup_}
       def clear!
         Vedeu.bind(:_clear_) do |name|
           if name
             Vedeu::Clear::NamedInterface.render(name)
 
@@ -64,137 +46,69 @@
 
           end
         end
       end
 
-      # Will cause the triggering of the `:command` event; which you should
-      # define to 'do things'
-      #
-      # @example
-      #   Vedeu.trigger(:_command_, command)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_command_}
       def command!
         Vedeu.bind(:_command_) { |command| Vedeu.trigger(:command, command) }
       end
 
-      # This event is called by {Vedeu::Input::Input#capture}. When
-      # invoked, the key will be passed to the editor for currently
-      # focussed view.
-      #
-      # @example
-      #   Vedeu.trigger(:_editor_, key)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_editor_}
       def editor!
         Vedeu.bind(:_editor_) do |key|
           Vedeu::Editor::Editor.keypress(name: Vedeu.focus, input: key)
         end
       end
 
-      # When triggered, Vedeu will trigger a `:cleanup` event which you can
-      # define (to save files, etc) and attempt to exit.
-      #
-      # @example
-      #   Vedeu.trigger(:_exit_)
-      #   Vedeu.exit
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_exit_}
       def exit!
         Vedeu.bind(:_exit_) { Vedeu::Runtime::Application.stop }
       end
 
-      # 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.
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_initialize_}
       def initialize!
         Vedeu.bind(:_initialize_) do
           Vedeu.ready!
           Vedeu.trigger(:_refresh_)
         end
       end
 
-      # 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 recognises most key presses and some 'extended'
-      # keypress (eg. Ctrl+J), a list of supported keypresses can be found here:
-      # {Vedeu::Input::Input#specials} and {Vedeu::Input::Input#f_keys}.
-      #
-      # @example
-      #   Vedeu.trigger(:_keypress_, key)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_keypress_}
       def keypress!
         Vedeu.bind(:_keypress_) { |key| Vedeu.keypress(key) }
       end
 
-      # When triggered with a message will cause Vedeu to log the message if
-      # logging is enabled in the configuration.
-      #
-      # @example
-      #   Vedeu.trigger(:_log_, message)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_log_}
       def log!
         Vedeu.bind(:_log_) { |msg| Vedeu.log(type: :debug, message: msg) }
       end
 
-      # Maximising an interface.
-      #
-      # @example
-      #   Vedeu.trigger(:_maximise_, name)
-      #
-      # @return [TrueClass]
-      # @see Vedeu::Geometry::Geometry#maximise
+      # See {file:docs/events/system.md#\_maximise_}
       def maximise!
         Vedeu.bind(:_maximise_) do |name|
           Vedeu.geometries.by_name(name).maximise
         end
       end
 
-      # When triggered (by default, after the user presses `escape`), Vedeu
-      # switches between modes of the terminal. The idea here being
-      # that the raw mode is for single keypress actions, whilst fake and cooked
-      # modes allow the user to enter more elaborate commands- such as commands
-      # with arguments.
-      #
-      # @example
-      #   Vedeu.trigger(:_mode_switch_)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_mode_switch_}
       def mode_switch!
         Vedeu.bind(:_mode_switch_) { fail Vedeu::Error::ModeSwitch }
       end
 
-      # When triggered will cause Vedeu to trigger the `:_clear_` and
-      # `:_refresh_` events. Please see those events for their behaviour.
-      #
-      # @example
-      #   Vedeu.trigger(:_resize_)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_resize_}
       def resize!
         Vedeu.bind(:_resize_, delay: 0.25) { Vedeu.resize }
       end
 
-      # Unmaximising an interface.
-      #
-      # @example
-      #   Vedeu.trigger(:_unmaximise_, name)
-      #
-      # @return [TrueClass]
-      # @see Vedeu::Geometry::Geometry#unmaximise
+      # See {file:docs/events/system.md#\_unmaximise_}
       def unmaximise!
         Vedeu.bind(:_unmaximise_) do |name|
           Vedeu.geometries.by_name(name).unmaximise
         end
       end
 
     end # System
-    # :nocov:
 
   end # Bindings
 
 end # Vedeu