lib/hallon/observable/session.rb in hallon-0.17.0 vs lib/hallon/observable/session.rb in hallon-0.18.0

@@ -21,85 +21,78 @@
     # @example listening to this event
     #   session.on(:logged_in) do |error|
     #     puts "Logged in: " + Hallon::Error.explain(error)
     #   end
     #
-    # @yield [error, self] logged_in
+    # @yield [error] logged_in
     # @yieldparam [Symbol] error
-    # @yieldparam [Session] self
     # @see Error
     def logged_in_callback(pointer, error)
       trigger(pointer, :logged_in, error)
     end
 
     # @example listening to this event
     #   session.on(:logged_out) do
     #     puts "AHHH!"
     #   end
     #
-    # @yield [self]
-    # @yieldparam [Session] self
+    # @yield []
     def logged_out_callback(pointer)
       trigger(pointer, :logged_out)
     end
 
     # @example listening to this event
     #   session.on(:metadata_updated) do
     #     puts "wut wut"
     #   end
     #
-    # @yield [self]
-    # @yieldparam [Session] self
+    # @yield []
     def metadata_updated_callback(pointer)
       trigger(pointer, :metadata_updated)
     end
 
     # @example listening to this event
     #   session.on(:connection_error) do |error|
     #     puts "Oh noes: " + Hallon::Error.explain(error)
     #   end
     #
-    # @yield [error, self]
+    # @yield [error]
     # @yieldparam [Symbol] error
-    # @yieldparam [Session] self
     # @see Error
     def connection_error_callback(pointer, error)
       trigger(pointer, :connection_error, error)
     end
 
     # @example listening to this event
     #   session.on(:message_to_user) do |message|
     #     puts "OH HAI: #{message}"
     #   end
     #
-    # @yield [message, self]
+    # @yield [message]
     # @yieldparam [String] message
-    # @yieldparam [Session] self
     def message_to_user_callback(pointer, message)
       trigger(pointer, :message_to_user, message)
     end
 
     # @example listening to this event
     #   session.on(:notify_main_thread) do
     #     puts "main thread turn on"
     #   end
     #
-    # @yield [self]
-    # @yieldparam [Session] self
+    # @yield []
     def notify_main_thread_callback(pointer)
       trigger(pointer, :notify_main_thread)
     end
 
     # @example listening to this event
     #   session.on(:music_delivery) do |format, frames|
     #     puts ""
     #   end
     #
-    # @yield [format, frames, self]
+    # @yield [format, frames]
     # @yieldparam [Hash] format (contains :type, :rate, :channels)
     # @yieldparam [Enumerator<[Integer...]>] frames (each frame is an array containing format[:channels] integers of format[:type])
-    # @yieldparam [Session] self
     def music_delivery_callback(pointer, format, frames, num_frames)
       struct = Spotify::AudioFormat.new(format)
 
       format = {}
       format[:rate] = struct[:sample_rate]
@@ -123,56 +116,51 @@
     # @example listening to this event
     #   session.on(:play_token_lost) do
     #     puts "another user set us up the bomb!"
     #   end
     #
-    # @yield [self]
-    # @yieldparam [Session] self
+    # @yield []
     def play_token_lost_callback(pointer)
       trigger(pointer, :play_token_lost)
     end
 
     # @example listening to this event
     #   session.on(:end_of_track) do
     #     puts "all your base are belong to us"
     #   end
     #
-    # @yield [self]
-    # @yieldparam [Session] self
+    # @yield []
     def end_of_track_callback(pointer)
       trigger(pointer, :end_of_track)
     end
 
     # @example listening to this event
     #   session.on(:start_playback) do
     #     puts "dum dum tiss"
     #   end
     #
-    # @yield [self]
-    # @yieldparam [Session] self
+    # @yield []
     def start_playback_callback(pointer)
       trigger(pointer, :start_playback)
     end
 
     # @example listening to this event
     #   session.on(:stop_playback) do
     #     puts "dum dum tiss"
     #   end
     #
-    # @yield [self]
-    # @yieldparam [Session] self
+    # @yield []
     def stop_playback_callback(pointer)
       trigger(pointer, :stop_playback)
     end
 
     # @example listening to this event
     #   session.on(:get_audio_buffer_stats) do
     #     puts "que?"
     #   end
     #
-    # @yield [self]
-    # @yieldparam [Session] self
+    # @yield []
     # @yieldreturn an integer pair, [samples, dropouts]
     def get_audio_buffer_stats_callback(pointer, stats)
       stats = Spotify::AudioBufferStats.new(stats)
       samples, dropouts = trigger(pointer, :get_audio_buffer_stats)
       stats[:samples]  = samples.to_i
@@ -182,71 +170,65 @@
     # @example listening to this event
     #   session.on(:streaming_error) do |error|
     #     puts "boo: " + Hallon::Error.explain(error)
     #   end
     #
-    # @yield [error, self]
+    # @yield [error]
     # @yieldparam [Symbol] error
-    # @yieldparam [Session] self
     def streaming_error_callback(pointer, error)
       trigger(pointer, :streaming_error, error)
     end
 
     # @example listening to this event
     #   session.on(:userinfo_updated) do
     #     puts "who am I?!"
     #   end
     #
-    # @yield [self]
-    # @yieldparam [Session] self
+    # @yield []
     def userinfo_updated_callback(pointer)
       trigger(pointer, :userinfo_updated)
     end
 
     # @example listening to this event
     #   session.on(:log_message) do |message|
     #     puts "for great justice: #{message}"
     #   end
     #
-    # @yield [message, self]
+    # @yield [message]
     # @yieldparam [String] message
-    # @yieldparam [Session] self
     def log_message_callback(pointer, message)
       trigger(pointer, :log_message, message)
     end
 
     # @example listening to this event
     #   session.on(:offline_status_updated) do |session|
     #     puts "All systems: #{session.status}"
     #   end
     #
-    # @yield [self]
-    # @yieldparam [Session] self
+    # @yield []
     def offline_status_updated_callback(pointer)
       trigger(pointer, :offline_status_updated)
     end
 
     # @example listening to this event
     #   session.on(:offline_error) do |error|
     #     puts "FAIL: " + Hallon::Error.explain(error)
     #   end
     #
-    # @yield [error, self]
+    # @yield [error]
     # @yieldparam [Symbol] error
-    # @yieldparam [Session] self
     def offline_error_callback(pointer, error)
       trigger(pointer, :offline_error, error)
     end
 
 
     # @example listening to this event
     #   session.on(:credentials_blob_updated) do |credentials|
     #     File.open('.spotify-credentials', 'w') { |io| io.write(credentials) }
     #   end
     #
-    # @yield [credentials, self]
+    # @yield [credentials]
     # @yieldparam [String] credentials
-    # @yieldparam [Session] self
     def credentials_blob_updated_callback(pointer, credentials)
       trigger(pointer, :credentials_blob_updated, credentials)
     end
 
     # @example listening to this event