lib/picasa/client.rb in picasa-0.4.0 vs lib/picasa/client.rb in picasa-0.4.1

@@ -1,13 +1,23 @@
 module Picasa
   class Client
     attr_reader :credentials
 
+    # @param [Hash] credentials
+    # @option credentials [String] :user_id google username/email
+    # @option credentials [String] :password password for given username/email
     def initialize(credentials = {})
       credentials[:user_id] || raise(ArgumentError, "You must specify user_id")
       @credentials = credentials
     end
 
+    # @return [API::Album]
+    #
+    # @example
+    #   client = Picasa::Client.new(user_id: "[e-mail]")
+    #   album_list = client.album.list
+    #   album_list.title
+    #   # => "My album"
     def album
       API::Album.new(credentials)
     end
   end
 end