Update documentation;

Mark Vedeu::Input classes as @api private.
gavinlaking · Jan 31, 2016 · 865ad3f · 865ad3f
1 parent 76edeac
commit 865ad3f
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 1 deletion.
diff --git a/lib/vedeu/input/keys.rb b/lib/vedeu/input/keys.rb
@@ -6,6 +6,8 @@ module Input
 
     # A collection of {Vedeu::Input::Key} instances.
     #
+    # @api private
+    #
     class Keys < Vedeu::Repositories::Collection
 
     end # Keys

diff --git a/lib/vedeu/input/mapper.rb b/lib/vedeu/input/mapper.rb
@@ -6,6 +6,8 @@ module Input
 
     # Maps keys to keymaps.
     #
+    # @api private
+    #
     class Mapper
 
       class << self

diff --git a/lib/vedeu/input/mouse.rb b/lib/vedeu/input/mouse.rb
@@ -6,6 +6,8 @@ module Input
 
     # Rudimentary support for mouse interactions.
     #
+    # @api private
+    #
     class Mouse
 
       # Trigger an event depending on which button was pressed.

diff --git a/lib/vedeu/runtime/flags.rb b/lib/vedeu/runtime/flags.rb
@@ -6,7 +6,7 @@ module Runtime
 
     # Home of various runtime flags which Vedeu uses.
     #
-    # @api public
+    # @api private
     #
     class Flags