From 865ad3f1e161d3354908566fe0f6aba8a51095be Mon Sep 17 00:00:00 2001 From: Gavin Laking Date: Fri, 29 Jan 2016 00:27:30 +0000 Subject: [PATCH] Update documentation; Mark Vedeu::Input classes as @api private. --- lib/vedeu/input/keys.rb | 2 ++ lib/vedeu/input/mapper.rb | 2 ++ lib/vedeu/input/mouse.rb | 2 ++ lib/vedeu/runtime/flags.rb | 2 +- 4 files changed, 7 insertions(+), 1 deletion(-) diff --git a/lib/vedeu/input/keys.rb b/lib/vedeu/input/keys.rb index 34db22649..5e7bc38a7 100644 --- 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 index c5107004f..ad26c9860 100644 --- 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 index a54e9544c..ab65fc46d 100644 --- 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 index c5b2fd18e..ac98c73a9 100644 --- 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