[rb] add class documentation and set api private all Interactions classes

titusfortner · titusfortner · commit 8bf63e72d485 · 2021-12-01T00:15:26.000-06:00
diff --git a/rb/lib/selenium/webdriver/common/interactions/input_device.rb b/rb/lib/selenium/webdriver/common/interactions/input_device.rb
@@ -22,6 +22,13 @@
 module Selenium
   module WebDriver
     module Interactions
+      #
+      # Superclass for the input device sources
+      # Manages Array of Interaction instances for the device
+      #
+      # @api private
+      #
+
       class InputDevice
         attr_reader :name, :actions
 
diff --git a/rb/lib/selenium/webdriver/common/interactions/interaction.rb b/rb/lib/selenium/webdriver/common/interactions/interaction.rb
@@ -20,6 +20,13 @@
 module Selenium
   module WebDriver
     module Interactions
+      #
+      # Superclass for classes defining actions
+      # Do not initialize directly, only use subclass
+      #
+      # @api private
+      #
+
       class Interaction
         attr_reader :type
 
diff --git a/rb/lib/selenium/webdriver/common/interactions/interactions.rb b/rb/lib/selenium/webdriver/common/interactions/interactions.rb
@@ -23,7 +23,10 @@ module Interactions
       KEY = :key
       POINTER = :pointer
       NONE = :none
-      SOURCE_TYPES = [KEY, POINTER, NONE].freeze
+
+      #
+      # Class methods for initializing known Input devices
+      #
 
       class << self
         def key(name)
diff --git a/rb/lib/selenium/webdriver/common/interactions/key_input.rb b/rb/lib/selenium/webdriver/common/interactions/key_input.rb
@@ -20,6 +20,12 @@
 module Selenium
   module WebDriver
     module Interactions
+      #
+      # Creates actions specific to Key Input devices
+      #
+      # @api private
+      #
+
       class KeyInput < InputDevice
         SUBTYPES = {down: :keyDown, up: :keyUp, pause: :pause}.freeze
 
diff --git a/rb/lib/selenium/webdriver/common/interactions/none_input.rb b/rb/lib/selenium/webdriver/common/interactions/none_input.rb
@@ -20,6 +20,13 @@
 module Selenium
   module WebDriver
     module Interactions
+      #
+      # Creates actions specific to null input source
+      # This is primarily used for adding pauses
+      #
+      # @api private
+      #
+
       class NoneInput < InputDevice
         def type
           Interactions::NONE
diff --git a/rb/lib/selenium/webdriver/common/interactions/pause.rb b/rb/lib/selenium/webdriver/common/interactions/pause.rb
@@ -20,6 +20,13 @@
 module Selenium
   module WebDriver
     module Interactions
+      #
+      # Action to create a waiting period between actions
+      # Also used for synchronizing actions across devices
+      #
+      # @api private
+      #
+
       class Pause < Interaction
         def initialize(source, duration = nil)
           super(source)
diff --git a/rb/lib/selenium/webdriver/common/interactions/pointer_cancel.rb b/rb/lib/selenium/webdriver/common/interactions/pointer_cancel.rb
@@ -20,6 +20,12 @@
 module Selenium
   module WebDriver
     module Interactions
+      #
+      # Action to cancel any other Pointer Action.
+      #
+      # @api private
+      #
+
       class PointerCancel < Interaction
         def initialize(source)
           super(source)
diff --git a/rb/lib/selenium/webdriver/common/interactions/pointer_input.rb b/rb/lib/selenium/webdriver/common/interactions/pointer_input.rb
@@ -20,6 +20,12 @@
 module Selenium
   module WebDriver
     module Interactions
+      #
+      # Creates actions specific to Pointer Input devices
+      #
+      # @api private
+      #
+
       class PointerInput < InputDevice
         KIND = {mouse: :mouse, pen: :pen, touch: :touch}.freeze
 
diff --git a/rb/lib/selenium/webdriver/common/interactions/pointer_move.rb b/rb/lib/selenium/webdriver/common/interactions/pointer_move.rb
@@ -20,6 +20,12 @@
 module Selenium
   module WebDriver
     module Interactions
+      #
+      # Actions related to moving the pointer.
+      #
+      # @api private
+      #
+
       class PointerMove < Interaction
         VIEWPORT = :viewport
         POINTER = :pointer
diff --git a/rb/lib/selenium/webdriver/common/interactions/pointer_press.rb b/rb/lib/selenium/webdriver/common/interactions/pointer_press.rb
@@ -20,6 +20,12 @@
 module Selenium
   module WebDriver
     module Interactions
+      #
+      # Actions related to clicking, tapping or pressing the pointer.
+      #
+      # @api private
+      #
+
       class PointerPress < Interaction
         BUTTONS = {left: 0, middle: 1, right: 2}.freeze
         DIRECTIONS = {down: :pointerDown, up: :pointerUp}.freeze
diff --git a/rb/lib/selenium/webdriver/common/interactions/typing_interaction.rb b/rb/lib/selenium/webdriver/common/interactions/typing_interaction.rb
@@ -20,6 +20,12 @@
 module Selenium
   module WebDriver
     module Interactions
+      #
+      # Actions related to pressing keys.
+      #
+      # @api private
+      #
+
       class TypingInteraction < Interaction
         attr_reader :type
 
