Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Tweak some more docstrings in mouse.rb

  • Loading branch information...
commit a56f7d1b76b2335ac56953d5e50f0bf9ebcfe722 1 parent c3230e3
@ferrous26 ferrous26 authored
View
9 lib/ax/element.rb
@@ -204,7 +204,8 @@ def perform action
##
# Perform a breadth first search through the view hierarchy rooted at
- # the current element.
+ # the current element. If you are concerned about the return value of
+ # this method, you can call {#blank?} on the return object.
#
# See the [Searching Tutorial](http://github.com/Marketcircle/AXElements/wiki/Searching)
# for the details on search semantics.
@@ -398,9 +399,8 @@ def blank?
end
##
- # @todo Need to add '?' to predicate methods, but how?
- #
# Like {#respond_to?}, this is overriden to include attribute methods.
+ # Though, it does include dynamic predicate methods at the moment.
def methods include_super = true, include_objc_super = false
super.concat(attributes).concat(parameterized_attributes)
end
@@ -408,8 +408,7 @@ def methods include_super = true, include_objc_super = false
##
# Overridden so that equality testing would work.
#
- # A hack, but the only sane way I can think of to test for
- # equivalency.
+ # A hack, but the only sane way I can think of to test for equivalency.
def == other
@ref == other.instance_variable_get(:@ref)
end
View
4 lib/ax_elements/awesome_print.rb
@@ -25,6 +25,10 @@ def cast_with_ax_elements object, type
private
+ ##
+ # Give the awesome output for an {AX::Element} object.
+ #
+ # @return [String]
def awesome_ax_element object
object.inspect
end
View
1  lib/ax_elements/nsarray_compat.rb
@@ -53,6 +53,7 @@ def method_missing method, *args
private
# @private
+ # @return [Accessibility::Translator]
TRANSLATOR = Accessibility::Translator.instance
end
View
3  lib/mouse.rb
@@ -8,7 +8,6 @@
# @todo More intelligent default duration
# @todo Refactor to try and reuse the same event for a single action
# instead of creating new events.
-# @todo Pause between down/up clicks
module Mouse
extend self
@@ -20,7 +19,7 @@ module Mouse
##
# @note We keep the number as a rational to try and avoid rounding
- # error introduced by the way MacRuby deals with floats.
+ # error introduced by the floats, especially MacRuby floats.
#
# Smallest unit of time allowed for an animation step.
#
View
6 lib/rspec/expectations/ax_elements.rb
@@ -33,9 +33,6 @@ def failure_message_for_should_not
"Expected #@parent to NOT have child #@result"
end
- ##
- # Implemented to override `NSObject#description`.
- #
# @return [String]
def description
"should have a child that matches #{@qualifier.describe}"
@@ -104,9 +101,6 @@ def failure_message_for_should_not
"Expected #@ancestor to NOT have descendent #@result"
end
- ##
- # Implemented to override `NSObject#description`.
- #
# @return [String]
def description
"should have a descendent matching #{@qualifier.describe}"
Please sign in to comment.
Something went wrong with that request. Please try again.