vedeu 0.4.32 → 0.4.33

data/lib/vedeu/dsl/presentation.rb

@@ -6,7 +6,6 @@ module Vedeu
     # {Vedeu::DSL::Line} and {Vedeu::DSL::Stream} classes.
     #
     # @api public
-    #
     module Presentation
 
       # Define the background colour for an interface, line, or a stream. When

data/lib/vedeu/dsl/text.rb

@@ -4,6 +4,7 @@ module Vedeu
 
     # Provides helper methods for building views.
     #
+    # @api public
     module Text
 
       # Specify the content for a view. Provides the means to align a string

data/lib/vedeu/dsl/use.rb

@@ -4,6 +4,7 @@ module Vedeu
 
     # Provides helper methods for building views.
     #
+    # @api public
     module Use
 
       # Duplicate a stored model.
@@ -40,7 +41,8 @@ module Vedeu
       #
       # This DSL method provides access to a stored model by name. You can
       # then request an attribute of that model for use within the current
-      # model.
+      # model. The models which current support this are Border, Geometry and
+      # Interface.
       #
       # @example
       #   # Here the character used for 'my_border' is used in

data/lib/vedeu/events/event.rb

@@ -29,6 +29,8 @@ module Vedeu
   #       # Not all events you define will have arguments; like methods.
   #       :do_stuff
   #     end
+  #
+  # @api public
   class Event
 
     include Vedeu::Model

data/lib/vedeu/events/trigger.rb

@@ -7,6 +7,8 @@ module Vedeu
   #
   # @example
   #   Vedeu.trigger(:my_event, :oxidize, 'nitrogen')
+  #
+  # @api public
   class Trigger
 
     # @param name [Symbol] The name of the event you wish to trigger. The event

data/lib/vedeu/geometry/area.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Define an area from dimensions or points.
+  #
+  # @api private
   class Area
 
     # @!attribute [r] y

data/lib/vedeu/geometry/coordinate.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Crudely corrects out of range values.
+  #
+  # @api private
   class Coordinate
 
     extend Forwardable

data/lib/vedeu/geometry/dimension.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # A Dimension is either the height or width of an entity.
+  #
+  # @api private
   class Dimension
 
     # @param (see #initialize)

data/lib/vedeu/geometry/geometry.rb

@@ -9,6 +9,7 @@ module Vedeu
   # Calculates and provides interface geometry determined by both the client's
   # requirements and the terminal's current viewing area.
   #
+  # @api private
   class Geometry
 
     extend Forwardable

data/lib/vedeu/geometry/grid.rb

@@ -19,6 +19,8 @@ module Vedeu
   #                     # Terminal is 38 characters wide, maximum value is
   #                     # therefore 36, meaning a row is 3 characters tall.
   #                     # (And height is therefore 9 characters tall.)
+  #
+  # @api public
   class Grid
 
     # @see #initialize

data/lib/vedeu/geometry/index_position.rb

@@ -4,6 +4,8 @@ module Vedeu
   #
   # When the optional offset `oy` and `ox` params are given, the they are used
   # for the starting position.
+  #
+  # @api private
   class IndexPosition
 
     # @param (see #initialize)

data/lib/vedeu/geometry/position.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Change coordinates into an escape sequence to set the cursor position.
+  #
+  # @api private
   class Position
 
     # @!attribute [r] y

data/lib/vedeu/geometry/position_index.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   # Converts a position into an index for the terminal. An index is the position
   # minus 1.
+  #
+  # @api private
   class PositionIndex
 
     # Convenience constructor for Vedeu::Position.

data/lib/vedeu/geometry/position_validator.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   # Validates that the provided coordinates are within the terminal and
   # interface's geometry (with or without a border).
+  #
+  # @api private
   class PositionValidator
 
     extend Forwardable

data/lib/vedeu/input/input.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   # Captures input from the user via {Vedeu::Terminal#input} and translates
   # special characters into symbols.
+  #
+  # @api private
   class Input
 
     # Instantiate Input and capture keypress(es).

data/lib/vedeu/input/key.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # A single keypress or combination of keypresses bound to a specific action.
+  #
+  # @api private
   class Key
 
     # @!attribute [r] input

data/lib/vedeu/input/keymap.rb

@@ -3,6 +3,8 @@ require 'vedeu/dsl/keymap'
 module Vedeu
 
   # A container class for keys associated with a particular interface.
+  #
+  # @api private
   class Keymap
 
     include Vedeu::Model

data/lib/vedeu/input/mapper.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Maps keys to keymaps.
+  #
+  # @api private
   class Mapper
 
     # Takes a key as a keypress and sends it to registered keymaps. If found,

data/lib/vedeu/main_loop.rb

@@ -2,6 +2,7 @@ module Vedeu
 
   # Provides the main loop for a Vedeu application.
   #
+  # @api private
   class MainLoop
 
     trap('SIGTERM') { stop! }

data/lib/vedeu/models/cell.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # A Cell represents a single square of the terminal.
+  #
+  # @api private
   class Cell
 
     # @!attribute [r] colour

data/lib/vedeu/models/char.rb

@@ -10,6 +10,8 @@ module Vedeu
   #
   # Though a multi-character String can be passed as a value, only the first
   # character is returned in the escape sequence.
+  #
+  # @api private
   class Char
 
     include Vedeu::Presentation

data/lib/vedeu/models/composition.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # A composition is a collection of interfaces.
+  #
+  # @api private
   class Composition
 
     include Vedeu::Model

data/lib/vedeu/models/escape_char.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Represents an invisible escape character sequence.
+  #
+  # @api private
   class EscapeChar
 
     # @!attribute [r] value

data/lib/vedeu/models/focus.rb

@@ -4,6 +4,7 @@ module Vedeu
   # serving to store and manipulate the which interface is currently being
   # focussed.
   #
+  # @api private
   module Focus
 
     extend self

data/lib/vedeu/models/group.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   # Interfaces can be associated with one another by being members of the same
   # Group. A Group is a collection of interface names.
+  #
+  # @api private
   class Group
 
     include Vedeu::Model

data/lib/vedeu/models/interface.rb

@@ -5,6 +5,8 @@ module Vedeu
   # An Interface represents a portion of the terminal defined by
   # {Vedeu::Geometry}. It is a container for {Vedeu::Line} and {Vedeu::Stream}
   # objects.
+  #
+  # @api private
   class Interface
 
     extend Forwardable

data/lib/vedeu/models/line.rb

@@ -3,6 +3,8 @@ module Vedeu
   # A Line represents a single row of the terminal. It is a container for
   # {Vedeu::Stream} objects. A line's width is determined by the
   # {Vedeu::Interface} it belongs to.
+  #
+  # @api private
   class Line
 
     include Vedeu::Model

data/lib/vedeu/models/menu.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   # Converts the collection passed into a list of menu items which can be
   # navigated using the instance methods or events provided.
+  #
+  # @api private
   class Menu
 
     include Vedeu::Model

data/lib/vedeu/models/panel.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Abstract interface class without the baggage.
+  #
+  # @api private
   class Panel
 
     # @return [Vedeu::Panel]

data/lib/vedeu/models/stream.rb

@@ -3,6 +3,8 @@ module Vedeu
   # A Stream can represent a character or collection of characters as part of a
   # {Vedeu::Line} which you wish to colour and style independently of the other
   # characters in that line.
+  #
+  # @api private
   class Stream
 
     include Vedeu::Model

data/lib/vedeu/null/all.rb

@@ -3,6 +3,8 @@ module Vedeu
   # A group of objects that serve to intercept messages destined for their
   # real counterpart. In most cases the call is muted or returns a generic
   # value that does not halt processing.
+  #
+  # @api private
   module Null
 
   end

data/lib/vedeu/null/border.rb

@@ -4,6 +4,8 @@ module Vedeu
 
     # Provides a non-existent Vedeu::Border that acts like the real thing, but
     # does nothing.
+    #
+    # @api private
     class Border
 
       # @!attribute [r] name

data/lib/vedeu/null/buffer.rb

@@ -4,6 +4,8 @@ module Vedeu
 
     # Provides a non-existent Vedeu::Buffer that acts like the real thing, but
     # does nothing.
+    #
+    # @api private
     class Buffer
 
       # @!attribute [r] name

data/lib/vedeu/null/generic.rb

@@ -3,6 +3,8 @@ module Vedeu
   module Null
 
     # Provides a non-existent model to swallow messages.
+    #
+    # @api private
     class Generic
 
       # Returns an instance of the Vedeu::Null::Generic class.

data/lib/vedeu/null/geometry.rb

@@ -3,6 +3,8 @@ module Vedeu
   module Null
 
     # Provides a non-existent model to swallow messages.
+    #
+    # @api private
     class Geometry
 
       extend Forwardable

data/lib/vedeu/null/interface.rb

@@ -3,6 +3,8 @@ module Vedeu
   module Null
 
     # Provides a non-existent model to swallow messages.
+    #
+    # @api private
     class Interface
 
       # @param name [String]

data/lib/vedeu/output/background.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   # The class represents one half (the other, can be found at
   # {Vedeu::Foreground}) of a terminal colour escape sequence.
+  #
+  # @api private
   class Background < Vedeu::Translator
 
     private

data/lib/vedeu/output/border.rb

@@ -7,6 +7,8 @@ module Vedeu
   #
   # @note Refer to UTF-8 U+2500 to U+257F for border characters. More details
   #   can be found at: http://en.wikipedia.org/wiki/Box-drawing_character
+  #
+  # @api private
   class Border
 
     extend Forwardable

data/lib/vedeu/output/clear.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Clears the area defined by an interface.
+  #
+  # @api private
   class Clear
 
     extend Forwardable

data/lib/vedeu/output/colour.rb

@@ -30,6 +30,7 @@ module Vedeu
   # area needs more work in Vedeu.
   #
   # @todo Fix colours in all terminals. (GL: 2015-04-13)
+  # @api private
   class Colour
 
     # @!attribute [r] attributes

data/lib/vedeu/output/compressor.rb

@@ -3,6 +3,8 @@ module Vedeu
   # During the conversion of a Vedeu::Char object into a string of escape
   # sequences, this class removes multiple occurences of the same escape
   # sequence, resulting in a smaller payload being sent to the renderer.
+  #
+  # @api private
   class Compressor
 
     # @param output [Array<Array<Vedeu::Char>>]

data/lib/vedeu/output/esc.rb

@@ -3,6 +3,7 @@ module Vedeu
   # Provides escape sequence strings for setting the cursor position and various
   # display related functions.
   #
+  # @api public
   module Esc
 
     extend self

data/lib/vedeu/output/foreground.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   # The class represents one half (the other, can be found at
   # {Vedeu::Background}) of a terminal colour escape sequence.
+  #
+  # @api private
   class Foreground < Vedeu::Translator
 
     private

data/lib/vedeu/output/html_char.rb

@@ -3,6 +3,8 @@ require 'vedeu/support/common'
 module Vedeu
 
   # Represents a {Vedeu::Char} as a HTML table cell.
+  #
+  # @api private
   class HTMLChar
 
     include Vedeu::Common