doc: add YARD doc for Favorite and Retweet model

1 files changed, 8 insertions, 2 deletions

diff --git a/app/models/favorite.rb b/app/models/favorite.rb
index d4728f8..da8087c 100644
--- a/app/models/favorite.rb
+++ b/app/models/favorite.rb
@@ -2,7 +2,10 @@ class Favorite < ActiveRecord::Base
   belongs_to :tweet
   belongs_to :user
 
-  # This doesn't update Tweet#reactions_count.
+  # Registers favorite event in bulk from an array of Streaming API events.
+  # This method doesn't update Tweet#reactions_count.
+  #
+  # @param [Array] array An array of Streaming API events.
   def self.create_bulk_from_json(array)
     objects = array.map do |json|
       self.new(user_id: json[:source][:id],
@@ -12,7 +15,10 @@ class Favorite < ActiveRecord::Base
     self.import(objects, ignore: true)
   end
 
-  # This doesn't update Tweet#reactions_count.
+  # Unregisters favorite event in bulk from an array of Streaming API 'unfavorite' events.
+  # This method doesn't update Tweet#reactions_count.
+  #
+  # @param [Array] array An array of Streaming API events.
   def self.delete_bulk_from_json(array)
     array.each do |json|
       self.delete_all(user_id: json[:source][:id], tweet_id: json[:target_object][:id])