vedeu 0.4.32 → 0.4.33

data/lib/vedeu/output/output.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Sends the content to the renderers.
+  #
+  # @api private
   class Output
 
     # Writes content to the defined renderers.

data/lib/vedeu/output/presentation.rb

@@ -3,6 +3,7 @@ module Vedeu
   # This module allows the sharing of presentation concerns between the models:
   # Interface, Line and Stream.
   #
+  # @api private
   module Presentation
 
     # @return [Vedeu::Background]

data/lib/vedeu/output/refresh.rb

@@ -2,6 +2,7 @@ module Vedeu
 
   # Refreshes the terminal.
   #
+  # @api private
   module Refresh
 
     module_function

data/lib/vedeu/output/renderers/all.rb

@@ -9,6 +9,8 @@ require_relative 'text'
 module Vedeu
 
   # Provides a single interface to all registered renderers.
+  #
+  # @api private
   module Renderers
 
     extend Enumerable
@@ -16,6 +18,7 @@ module Vedeu
 
     # Provides access to the list of renderers.
     #
+    # @api public
     # @return [Module]
     def renderers
       self

data/lib/vedeu/output/renderers/escape_sequence.rb

@@ -3,6 +3,8 @@ module Vedeu
   module Renderers
 
     # A renderer which returns the escape sequence for each character.
+    #
+    # @api private
     class EscapeSequence
 
       # @param output [Array<Array<Vedeu::Char>>]

data/lib/vedeu/output/renderers/file.rb

@@ -5,6 +5,8 @@ module Vedeu
     # Converts a grid of {Vedeu::Char} objects into a stream of escape sequences
     # and content suitable for a terminal, and writes them to a file in the /tmp
     # directory.
+    #
+    # @api private
     class File
 
       # @param output [Array<Array<Vedeu::Char>>]

data/lib/vedeu/output/renderers/html.rb

@@ -3,6 +3,8 @@ module Vedeu
   module Renderers
 
     # Renders a {Vedeu::VirtualBuffer} or {Vedeu::Output} as a HTML table.
+    #
+    # @api private
     class HTML
 
       # @param output [Array<Array<Vedeu::Char>>]

data/lib/vedeu/output/renderers/json.rb

@@ -3,6 +3,8 @@ module Vedeu
   module Renderers
 
     # Renders a {Vedeu::VirtualBuffer} or {Vedeu::Output} as JSON.
+    #
+    # @api private
     class JSON
 
       # @param output [Array<Array<Vedeu::Char>>]

data/lib/vedeu/output/renderers/null.rb

@@ -3,6 +3,8 @@ module Vedeu
   module Renderers
 
     # A renderer which returns nothing.
+    #
+    # @api private
     class Null
 
       # @return [NilClass]

data/lib/vedeu/output/renderers/terminal.rb

@@ -4,6 +4,8 @@ module Vedeu
 
     # Converts a grid of {Vedeu::Char} objects into a stream of escape sequences
     # and content suitable for a terminal.
+    #
+    # @api private
     class Terminal
 
       # @param output [Array<Array<Vedeu::Char>>]

data/lib/vedeu/output/renderers/text.rb

@@ -4,6 +4,8 @@ module Vedeu
 
     # Converts a grid of {Vedeu::Char} objects into a stream of escape sequences
     # and content.
+    #
+    # @api private
     class Text
 
       # @param output [Array<Array<Vedeu::Char>>]

data/lib/vedeu/output/style.rb

@@ -9,6 +9,7 @@ module Vedeu
   # Styles are applied as encountered.
   #
   # @see Vedeu::Esc
+  # @api private
   class Style
 
     include Vedeu::Common

data/lib/vedeu/output/text.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Present a string (or object responding to `to_s`).
+  #
+  # @api private
   class Text
 
     # @see Vedeu::DSL::Text#text

data/lib/vedeu/output/translator.rb

@@ -19,6 +19,8 @@ module Vedeu
   # a 24-bit representation.
   #
   # @todo More documentation required (create a fancy chart!)
+  #
+  # @api private
   class Translator
 
     # @!attribute [r] colour

data/lib/vedeu/output/viewport.rb

@@ -5,6 +5,8 @@ module Vedeu
   # When a buffer has more lines than the defined height, or more columns than
   # the defined width of the interface, the Viewport class provides 'scrolling'
   # via the cursor's position.
+  #
+  # @api private
   class Viewport
 
     extend Forwardable

data/lib/vedeu/output/virtual_terminal.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Represents a {Vedeu::Terminal} view as a grid of {Vedeu::Cell} objects.
+  #
+  # @api private
   class VirtualTerminal
 
     # @!attribute [rw] renderer

data/lib/vedeu/output/wordwrap.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Wrap or prune text.
+  #
+  # @api private
   class Wordwrap
 
     # @see {Vedeu::Wordwrap#initialize}

data/lib/vedeu/repositories/collection.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   # Convert an Array into an object which has some meaning in the context it
   # is being used.
+  #
+  # @api private
   class Collection
 
     include Enumerable

data/lib/vedeu/repositories/collections/all.rb

@@ -3,31 +3,43 @@ require 'vedeu/repositories/collection'
 module Vedeu
 
   # A collection of {Vedeu::Char} instances.
+  #
+  # @api private
   class Chars < Vedeu::Collection
 
   end # Chars
 
   # A collection of {Vedeu::Event} instances.
+  #
+  # @api private
   class Events < Vedeu::Collection
 
   end # Events
 
   # A collection of {Vedeu::Interface} instances.
+  #
+  # @api private
   class Interfaces < Vedeu::Collection
 
   end # Interfaces
 
   # A collection of {Vedeu::Key} instances.
+  #
+  # @api private
   class Keys < Vedeu::Collection
 
   end # Keys
 
   # A collection of {Vedeu::Line} instances.
+  #
+  # @api private
   class Lines < Vedeu::Collection
 
   end # Lines
 
   # A collection of {Vedeu::Stream} instances.
+  #
+  # @api private
   class Streams < Vedeu::Collection
 
   end # Streams

data/lib/vedeu/repositories/model.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   # When included into a class, provides the mechanism to store the class in a
   # repository for later retrieval.
+  #
+  # @api private
   module Model
 
     # @!attribute [rw] repository

data/lib/vedeu/repositories/registerable.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   # Repositories contain registerables, this module provides convenience methods
   # for them.
+  #
+  # @api private
   module Registerable
 
     # These class methods are mixed into the repository.

data/lib/vedeu/repositories/repositories/background_colours.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Store background colour escape sequences by HTML/CSS code.
+  #
+  # @api public
   class BackgroundColours < Colours
 
     # @return [Vedeu::BackgroundColours]

data/lib/vedeu/repositories/repositories/borders.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   # Allows the storing of interface/view borders independent of the interface
   # instance.
+  #
+  # @api public
   class Borders < Repository
 
     class << self

data/lib/vedeu/repositories/repositories/buffers.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Allows the storing of view buffers.
+  #
+  # @api public
   class Buffers < Repository
 
     class << self

data/lib/vedeu/repositories/repositories/colours.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   # Allows the storing of HTML/CSS colours and their respective escape
   # sequences.
+  #
+  # @api public
   class Colours
 
     # @!attribute [r] storage

data/lib/vedeu/repositories/repositories/cursors.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Allows the storing of each interface's cursor.
+  #
+  # @api public
   class Cursors < Repository
 
     class << self

data/lib/vedeu/repositories/repositories/events_repository.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Allows the storing of events.
+  #
+  # @api public
   class EventsRepository < Repository
 
     class << self

data/lib/vedeu/repositories/repositories/foreground_colours.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Store foreground colour escape sequences by HTML/CSS code.
+  #
+  # @api public
   class ForegroundColours < Colours
 
     # @return [Vedeu::ForegroundColours]

data/lib/vedeu/repositories/repositories/geometries.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   # Allows the storing of interface/view geometry independent of the interface
   # instance.
+  #
+  # @api public
   class Geometries < Repository
 
     class << self

data/lib/vedeu/repositories/repositories/groups.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Allows the storing of view groups.
+  #
+  # @api public
   class Groups < Repository
 
     class << self

data/lib/vedeu/repositories/repositories/interfaces_repository.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Allows the storing of interfaces and views.
+  #
+  # @api public
   class InterfacesRepository < Repository
 
     class << self

data/lib/vedeu/repositories/repositories/keymaps.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Allows the storing of keymaps.
+  #
+  # @api public
   class Keymaps < Repository
 
     class << self

data/lib/vedeu/repositories/repositories/menus.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Allows the storing of menus by name.
+  #
+  # @api public
   class Menus < Repository
 
     class << self

data/lib/vedeu/repositories/repository.rb

@@ -8,6 +8,8 @@ module Vedeu
   #   { 'models' => [Model, Model, Model] }
   #
   #   { 'models' => [Model] }
+  #
+  # @api private
   class Repository
 
     include Vedeu::Common
@@ -41,11 +43,9 @@ module Vedeu
 
     # @return [Array<void>] An array containing each stored model.
     def all
-      return []             if empty?
       return storage.values if storage.is_a?(Hash)
-      return storage.to_a   if storage.is_a?(Set)
 
-      storage
+      registered
     end
 
     # @param name [String] The name of the stored model.

data/lib/vedeu/storage/associative_store.rb

@@ -3,6 +3,8 @@ module Vedeu
   # Name/Value storage.
   #
   #   name: [value]
+  #
+  # @api private
   class AssociativeStore
 
     include Vedeu::Store

data/lib/vedeu/storage/conveyor_store.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   # Conveyor belt like storage. The belt can move forward (`load_next`) or
   # backwards (`load_previous`), or a named entry can be retrieved.
+  #
+  # @api private
   class ConveyorStore
 
     include Vedeu::Store

data/lib/vedeu/storage/fifo_store.rb

@@ -3,6 +3,8 @@ module Vedeu
   # First-in first-out storage.
   #
   #   in -> [3] -> [2] -> [1] -> out
+  #
+  # @api private
   class FifoStore
 
     include Vedeu::Store

data/lib/vedeu/storage/store.rb

@@ -2,6 +2,7 @@ module Vedeu
 
   # Provides generic repository related behaviour.
   #
+  # @api private
   module Store
 
     include Enumerable

data/lib/vedeu/support/common.rb

@@ -2,6 +2,7 @@ module Vedeu
 
   # A module for common methods used throughout Vedeu.
   #
+  # @api private
   module Common
 
     # Returns a boolean indicating whether a variable has a useful value.