discorb 0.15.0 → 0.15.1

data/lib/discorb/webhook.rb

@@ -22,7 +22,13 @@ module Discorb
     # @return [String] The URL of the webhook.
     attr_reader :token
 
+    #
+    # Initializes a webhook.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data of the webhook.
+    #
     def initialize(client, data)
       @name = data[:name]
       @guild_id = data[:guild_id] && Snowflake.new(data[:guild_id])
@@ -200,7 +206,13 @@ module Discorb
       # @!attribute [r] url
       #   @return [String] The URL of the webhook.
 
+      #
+      # Initializes the incoming webhook.
       # @private
+      #
+      # @param [Discorb::Client] client The client.
+      # @param [String] url The URL of the webhook.
+      #
       def initialize(client, data)
         super
         @token = data[:token]
@@ -222,7 +234,13 @@ module Discorb
       #   Represents a source channel of follower webhook.
       #   @return [Discorb::Channel, Discorb::Webhook::FollowerWebhook::Channel] The source channel of follower webhook.
 
+      #
+      # Initializes the follower webhook.
       # @private
+      #
+      # @param [Discorb::Client] client The client.
+      # @param [Hash] data The data of the follower webhook.
+      #
       def initialize(client, data)
         super
         @source_guild = FollowerWebhook::Guild.new(data[:source_guild])
@@ -248,12 +266,21 @@ module Discorb
         # @return [Discorb::Asset] The icon of the guild.
         attr_reader :icon
 
+        #
+        # Initialize a new guild.
         # @private
+        #
+        # @param [Hash] data The data of the guild.
+        #
         def initialize(data)
           @id = Snowflake.new(data[:id])
           @name = data[:name]
           @icon = Asset.new(self, data[:icon])
         end
+
+        def inspect
+          "#<#{self.class.name} #{@id}: #{@name}>"
+        end
       end
 
       #
@@ -265,11 +292,20 @@ module Discorb
         # @return [String] The name of the channel.
         attr_reader :name
 
+        #
+        # Initialize a new channel.
         # @private
+        #
+        # @param [Hash] data The data of the channel.
+        #
         def initialize(data)
           @id = Snowflake.new(data[:id])
           @name = data[:name]
         end
+
+        def inspect
+          "#<#{self.class.name} #{@id}: #{@name}>"
+        end
       end
     end
 
@@ -290,7 +326,13 @@ module Discorb
       # @return [Discorb::Snowflake] The ID of the guild.
       attr_reader :guild_id
 
+      #
+      # Initializes the message.
       # @private
+      #
+      # @param [Discorb::Webhook] webhook The webhook.
+      # @param [Hash] data The data of the message.
+      # @param [Discorb::Client] client The client. This will be nil if it's created from {URLWebhook}.
       def initialize(webhook, data, client = nil)
         @client = client
         @webhook = webhook
@@ -329,7 +371,7 @@ module Discorb
 
       def _set_data(data)
         @id = Snowflake.new(data[:id])
-        @type = Discorb::Message.message_type[data[:type]]
+        @type = Discorb::Message::MESSAGE_TYPE[data[:type]]
         @content = data[:content]
         @channel_id = Snowflake.new(data[:channel_id])
         @author = Author.new(data[:author])
@@ -364,7 +406,12 @@ module Discorb
         # @return [String] The discriminator of the author.
         attr_reader :discriminator
 
+        #
+        # Initializes the author.
         # @private
+        #
+        # @param [Hash] data The data of the author.
+        #
         def initialize(data)
           @data = data
           @bot = data[:bot]
@@ -384,6 +431,10 @@ module Discorb
         end
 
         alias to_s_user to_s
+
+        def inspect
+          "#<#{self.class.name} #{self}>"
+        end
       end
     end
 

data/lib/discorb.rb

@@ -4,7 +4,10 @@
 #
 # @author sevenc-nanashi
 module Discorb
+  #
+  # Method to define a macro for YARD.
   # @private
+  #
   # @!macro [new] async
   #   @note This is an asynchronous method, it will return a `Async::Task` object. Use `Async::Task#wait` to get the result.
   #
@@ -23,7 +26,6 @@ module Discorb
   #   @raise [Discorb::HTTPError] HTTP request failed.
   #
   def macro
-    # NOTE: this method is only for YARD.
     puts "Wow, You found the easter egg!\n"
     red = "\e[31m"
     reset = "\e[m"