vedeu 0.4.56 → 0.4.57

data/lib/vedeu/buffers/buffer.rb

@@ -11,7 +11,6 @@ module Vedeu
   # is copied to the 'Front' buffer, the current 'Front' buffer is also copied
   # to the 'Previous' buffer.
   #
-  # @api private
   class Buffer
 
     include Vedeu::Model

data/lib/vedeu/buffers/display_buffer.rb

@@ -3,7 +3,6 @@ module Vedeu
   # This module is included in Vedeu::Interface to provide means to store client
   # application views created with {Vedeu.renders} or {Vedeu.views}.
   #
-  # @api private
   module DisplayBuffer
 
     include Vedeu::Common

data/lib/vedeu/cli/generator/application.rb

@@ -9,7 +9,6 @@ module Vedeu
     #   vedeu new your_app_name_here
     #   ```
     #
-    # @api private
     # :nocov:
     class Application
 

data/lib/vedeu/cli/generator/helpers.rb

@@ -7,7 +7,6 @@ module Vedeu
     # Provides functionality used by the generators to build the client
     # application.
     #
-    # @api private
     # :nocov:
     module Helpers
 

data/lib/vedeu/cli/generator/view.rb

@@ -11,7 +11,6 @@ module Vedeu
     #   vedeu view main_screen
     #   ```
     #
-    # @api private
     # :nocov:
     class View
 

data/lib/vedeu/colours/background.rb

@@ -3,7 +3,6 @@ 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::ColourTranslator
 
     private

data/lib/vedeu/colours/colour.rb

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

data/lib/vedeu/colours/colour_translator.rb

@@ -20,7 +20,6 @@ module Vedeu
   #
   # @todo More documentation required (create a fancy chart!)
   #
-  # @api private
   class ColourTranslator
 
     # @!attribute [r] colour

data/lib/vedeu/colours/foreground.rb

@@ -3,7 +3,6 @@ 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::ColourTranslator
 
     private

data/lib/vedeu/common.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # A module for common methods used throughout Vedeu.
   #
-  # @api private
   module Common
 
     # Removes the module part from the expression in the string.

data/lib/vedeu/configuration/configuration.rb

@@ -27,7 +27,6 @@ module Vedeu
   # application settings (via the configuration API), or any command-line
   # arguments provided.
   #
-  # @api private
   class Configuration
 
     include Singleton

data/lib/vedeu/cursor/cursor.rb

@@ -5,7 +5,6 @@ module Vedeu
   # Each interface has its own Cursor which maintains the position and
   # visibility of the cursor within that interface.
   #
-  # @api private
   class Cursor
 
     include Vedeu::Model

data/lib/vedeu/cursor/move.rb

@@ -39,7 +39,6 @@ module Vedeu
   #   The view will move freely within the bounds of the interface,
   #     irrespective of content.
   #
-  # @api private
   class Move
 
     extend Forwardable

data/lib/vedeu/cursor/refresh_cursor.rb

@@ -3,7 +3,6 @@ module Vedeu
   # Handle the refreshing (redrawing) of a cursor, without redrawing the whole
   # interface; unless the cursor's offset has caused the view to change.
   #
-  # @api private
   class RefreshCursor
 
     extend Forwardable

data/lib/vedeu/cursor/reposition.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Provides the mechanism to arbitrarily move a cursor to a given position.
   #
-  # @api private
   class Reposition
 
     # @return [Vedeu::Cursor]

data/lib/vedeu/distributed/client.rb

@@ -1,5 +1,7 @@
 module Vedeu
 
+  # Provides a mechanism to control a running client application via DRb.
+  #
   module Distributed
 
     # A class for the client side of the DRb server/client relationship.

data/lib/vedeu/distributed/server.rb

@@ -1,5 +1,7 @@
 module Vedeu
 
+  # Provides a mechanism to control a running client application via DRb.
+  #
   module Distributed
 
     # A class for the server side of the DRb server/client relationship.

data/lib/vedeu/distributed/uri.rb

@@ -1,11 +1,12 @@
 module Vedeu
 
+  # Provides a mechanism to control a running client application via DRb.
+  #
   module Distributed
 
     # Value class which provides the host and port for the DRb server and
     # client.
     #
-    # @api private
     class Uri
 
       # @!attribute [r] host

data/lib/vedeu/exceptions.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Raised with Vedeu attempts to access a named model that does not exist.
   #
-  # @api private
   class ModelNotFound < StandardError
 
   end # ModeSwitch
@@ -10,7 +9,6 @@ module Vedeu
   # Raised when Vedeu attempts to parse a {Vedeu.view} or {Vedeu.interface} and
   # encounters a problem.
   #
-  # @api private
   class InvalidSyntax < StandardError
 
   end # InvalidSyntax
@@ -18,7 +16,6 @@ module Vedeu
   # Raised when a name is not provided for a model when attempting to store it
   # in a repository.
   #
-  # @api private
   class MissingRequired < StandardError
 
   end # MissingRequired
@@ -28,7 +25,6 @@ module Vedeu
   #
   # @see Vedeu::Application
   #
-  # @api private
   class ModeSwitch < StandardError
 
   end # ModeSwitch
@@ -38,7 +34,6 @@ module Vedeu
   #
   # @see Vedeu::ColourTranslator
   #
-  # @api private
   class NotImplemented < StandardError
 
   end # NotImplemented
@@ -48,7 +43,6 @@ module Vedeu
   #
   # @see Vedeu::Grid
   #
-  # @api private
   class OutOfRange < StandardError
 
   end # OutOfRange
@@ -57,7 +51,6 @@ module Vedeu
   #
   # @see Vedeu::MainLoop
   #
-  # @api private
   class VedeuInterrupt < StandardError
 
   end # VedeuInterrupt

data/lib/vedeu/geometry/area.rb

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

data/lib/vedeu/geometry/coordinate.rb

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

data/lib/vedeu/geometry/dimension.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # A Dimension is either the height or width of an entity.
   #
-  # @api private
   class Dimension
 
     # @param (see #initialize)
@@ -26,16 +25,22 @@ module Vedeu
       @attributes.each { |key, value| instance_variable_set("@#{key}", value) }
     end
 
+    # Fetch the starting coordinate.
+    #
     # @return [Fixnum]
     def d1
       dimension.first < 1 ? 1 : dimension.first
     end
 
+    # Fetch the ending coordinate.
+    #
     # @return [Fixnum]
     def d2
       dimension.last
     end
 
+    # Fetch the coordinates.
+    #
     # @return [Array<Fixnum>]
     def pair
       dimension
@@ -104,21 +109,29 @@ module Vedeu
       end
     end
 
+    # Ascertains the centred starting coordinate.
+    #
     # @return [Fixnum]
     def centred_d
       (default / 2) - (length / 2)
     end
 
+    # Ascertains the centred ending coordinate.
+    #
     # @return [Fixnum]
     def centred_dn
       (default / 2) + (length / 2)
     end
 
+    # Fetch the starting coordinate, or use 1 if not set.
+    #
     # @return [Fixnum]
     def _d
       d || 1
     end
 
+    # Fetch the ending coordinate.
+    #
     # @return [Fixnum]
     def _dn
       if dn

data/lib/vedeu/geometry/geometry.rb

@@ -9,7 +9,6 @@ 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/index_position.rb

@@ -5,7 +5,6 @@ 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

@@ -2,7 +2,6 @@ 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

@@ -3,7 +3,6 @@ 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

@@ -3,7 +3,6 @@ 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

@@ -3,7 +3,6 @@ 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

@@ -2,7 +2,6 @@ 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

@@ -5,7 +5,6 @@ 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

@@ -2,7 +2,6 @@ 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/log.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Allows the creation of a lock-less log device.
   #
-  # @api private
   class MonoLogger < Logger
 
     # Create a trappable Logger instance.

data/lib/vedeu/main_loop.rb

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

data/lib/vedeu/models/cell.rb

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

data/lib/vedeu/models/char.rb

@@ -11,7 +11,6 @@ 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 Comparable

data/lib/vedeu/models/composition.rb

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

data/lib/vedeu/models/escape.rb

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

data/lib/vedeu/models/focus.rb

@@ -12,7 +12,6 @@ module Vedeu
   #   - If the `Vedeu.focus_by_name 'some_interface'` declaration is used, then
   #     the list pointer (`current`) is set to the interface of that name.
   #
-  # @api private
   module Focus
 
     extend self