Rdoc (#6)

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boaw (0.1.2)
+    boaw (0.1.3)
 
 GEM
   remote: https://rubygems.org/

lib/boaw.rb

@@ -8,14 +8,20 @@ def initialize
     @adapter = Xdotool::Adapter.new
   end
 
+  # method returns the current cursor position
+  # { :x => 1, :y =>2 }
   def position
     adapter.position
   end
 
+  # clicks with the left mouse button,
+  # takes the position coordinates as input
   def left_click(position)
     adapter.left_click(position)
   end
 
+  # clicks with the right mouse button,
+  # takes the position coordinates as input
   def right_click(position)
     adapter.right_click(position)
   end

lib/boaw/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Boaw
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

lib/xdotool/adapter.rb

@@ -5,7 +5,7 @@
 
 module Xdotool
   # Xdotool adapter for mouse control
-  class Adapter
+  class Adapter # :nodoc: all
     def initialize
       result = Kernel.system('xdotool version')
       raise BaseError if result.nil?

lib/xdotool/base_error.rb

@@ -2,7 +2,7 @@
 
 module Xdotool
   # default error
-  class BaseError < StandardError
+  class BaseError < StandardError # :nodoc: all
     def message
       'failed to initialize xdotool module'
     end

lib/xdotool/position_parser.rb

@@ -2,7 +2,7 @@
 
 module Xdotool
   # coordinate position parser from Xdotool
-  class PositionParser
+  class PositionParser # :nodoc: all
     def self.parse(position)
       hash_position = position.scan(/(\w+):(\d+)/).to_h
 

test/lib/boaw/version_test.rb

@@ -4,6 +4,6 @@
 
 class VersionTest < Minitest::Test
   def test_version
-    assert_equal '0.1.2', Boaw::VERSION
+    assert_equal '0.1.3', Boaw::VERSION
   end
 end