lib/calabash/application.rb in calabash-1.9.9.pre2 vs lib/calabash/application.rb in calabash-1.9.9.pre3

@@ -1,24 +1,32 @@
 require 'digest'
 
 module Calabash
-  # A representation of the application that is under test.
+  # A representation of an application that is under test.
   class Application
+    # @!visibility private
     include Calabash::Utility
 
+    # @!visibility private
     @@default = nil
 
+    # @!visibility private
     def self.default
       @@default
     end
 
+    # @!visibility private
     def self.default=(value)
       @@default = value
     end
 
     attr_reader :path
 
+    # Create an application from a path
+    #
+    # @return [Calabash::Android::Application, Calabash::IOS::Application] An
+    #  application for `path`.
     def self.from_path(path)
       extension = File.extname(path)
 
       case extension
         when '.apk'
@@ -41,31 +49,42 @@
       @logger = options[:logger] || Calabash::Logger.new
       @identifier = options[:identifier]
       ensure_application_path
     end
 
+    # @!visibility private
     def to_s
       "#<Application #{path}>"
     end
 
+    # @!visibility private
     def inspect
       to_s
     end
 
+    # @!visibility private
     def extract_identifier
       abstract_method!
     end
 
+    # The identifier of the app. On iOS this is known as the bundle id, on
+    # Android this is known as the package. If the application has not been
+    # given an identifier in #initialize, this method will try to extract the
+    # identifier of the app.
+    #
+    # @return [String] The identifier if the app
     def identifier
       @identifier ||= extract_identifier
     end
 
+    # @!visibility private
     def md5_checksum
       Digest::MD5.file(path).hexdigest
     end
 
     private
 
+    # @!visibility private
     def ensure_application_path
       unless File.exist?(path)
         raise "The app '#{path}' does not exist."
       end
     end