AXElements 0.7.8 → 0.8.0

data/.yardopts

@@ -5,15 +5,6 @@
 --markup-provider redcarpet
 --asset docs/images:images
 --readme README.markdown
+--hide-void-return
 lib/**/*.rb
 ext/**/*{.m,.c}
--
-docs/Inspecting.markdown
-docs/Acting.markdown
-docs/Searching.markdown
-docs/Notifications.markdown
-docs/KeyboardEvents.markdown
-docs/Debugging.markdown
-docs/NewBehaviour.markdown
-docs/AccessibilityTips.markdown
-docs/TestingExtensions.markdown

data/README.markdown

@@ -21,7 +21,7 @@ from a quick look window:
     require 'ax_elements'
 
     finder = app_with_bundle_identifier 'com.apple.finder'
-    set_focus finder # bring to the front so you can see it happening
+    set_focus_to finder # bring to the front so you can see it happening
 
     type "\\COMMAND+n"
     sleep 1 # this is so you can see it happen in "slow motion"
@@ -60,8 +60,9 @@ slider in the menu bar (unless you've hidden it):
 
 ## Getting Setup
 
-You need to have the OS X developer tools installed in build and
-install AXElements (sorry). Go ahead and install the tools now if you
+You need to have the OS X command line tools installed in order to
+build and install AXElements, but you will also need Xcode in order to
+run the test suite (sorry). Go ahead and install the tools now if you
 haven't done that yet, I'll wait. Once you have the developer tools,
 you should install MacRuby, the latest nightly build is required. If you
 are on Snow Leopard, you will also need to install the
@@ -109,18 +110,10 @@ disable it like so:
 
 ## Getting Started
 
-The
-[documentation](http://rdoc.info/github/Marketcircle/AXElements/master/frames)
+The [wiki](http://github.com/Marketcircle/AXElements/wiki)
 is the best place to get started, it includes tutorials to help you get
 started as well the API documentation (API docs are broken right now due
-to incompatabilities between MacRuby and YARD). The starting tutorial is the
-[Inspecting Tutorial](docs/Inspecting.markdown).
-
-Documentation is hosted by rdoc.info, but you can also generate it yourself
-using YARD. Documentation is stored in the `docs/` directory, but the
-documentation includes a number of cross references and even some
-pictures so you will lose a lot of the quality if you view them as
-plain text.
+to incompatabilities between MacRuby and YARD).
 
 Though it is not required, you may want to read Apple's
 [Accessibility Overview](http://developer.apple.com/library/mac/#documentation/Accessibility/Conceptual/AccessibilityMacOSX/OSXAXModel/OSXAXmodel.html)
@@ -137,7 +130,7 @@ increase. Documentation will be overhauled and more examples will be
 added. It will be magical, so we're code naming the next version
 "Clefairy".
 
-![The Moon](https://github.com/Marketcircle/AXElements/raw/master/docs/images/next_version.png)
+![The Moon](https://github.com/Marketcircle/AXElements/raw/gh-pages/images/next_version.png)
 
 Proper releases to rubygems will be made as milestones are reached.
 

data/ext/accessibility/key_coder/key_coder.c

@@ -107,6 +107,13 @@ keycoder_post_event(VALUE self, VALUE event)
 void
 Init_key_coder()
 {
+  /*
+   *  Document-class: KeyCoder
+   *
+   *  Class that encapsulates some low level work for finding key code mappings
+   *  and posting keyboard events to the system.
+   *
+   */
   VALUE cKeyCoder = rb_define_class("KeyCoder", rb_cObject);
   rb_define_singleton_method(cKeyCoder, "dynamic_mapping", keycoder_dynamic_mapping, 0);
   rb_define_singleton_method(cKeyCoder, "post_event", keycoder_post_event, 1);

data/lib/AXElements.rb

@@ -1,3 +1 @@
-$stderr.puts "require 'AXElements' is deprecated."
-$stderr.puts "Please require 'ax_elements' instead."
 require 'ax_elements'