Fix yard doc warnings

Author: estolfo

lib/mongo/dbref.rb

@@ -79,7 +79,7 @@ def initialize(collection, id, database = nil)
     # @example Convert the DBRef to raw BSON.
     #   dbref.to_bson
     #
-    # @param [ String ] encoded The encoded BSON to append to.
+    # @param [ String ] buffer The encoded BSON buffer to append to.
     #
     # @return [ String ] The raw BSON.
     #
@@ -92,7 +92,7 @@ module ClassMethods
 
       # Deserialize the hash from BSON, converting to a DBRef if appropriate.
       #
-      # @param [ IO ] bson The bson representing a hash.
+      # @param [ String ] buffer The bson representing a hash.
       #
       # @return [ Hash, DBRef ] The decoded hash or DBRef.
       #

lib/mongo/grid/file/chunk.rb

@@ -128,7 +128,7 @@ def initialize(document)
         # @example Convert the chunk to BSON.
         #   chunk.to_bson
         #
-        # @param [ String ] encoded The encoded data to append to.
+        # @param [ String ] buffer The encoded data buffer to append to.
         #
         # @return [ String ] The raw BSON data.
         #

lib/mongo/protocol/bit_vector.rb

@@ -24,7 +24,7 @@ class BitVector
 
         # Initializes a BitVector with a layout
         #
-        # @param layout [Array<Symbol>] the array of fields in the bit vector
+        # @param layout [ Array<Symbol> ] the array of fields in the bit vector
         def initialize(layout)
           @masks = {}
           layout.each_with_index do |field, index|
@@ -34,9 +34,10 @@ def initialize(layout)
 
         # Serializes vector by encoding each symbol according to its mask
         #
-        # @param buffer [IO] Buffer to receive the serialized vector
-        # @param value [Array<Symbol>] Array of flags to encode
-        # @return [IO] Buffer that received the serialized vector
+        # @param buffer [ String ] Buffer to receive the serialized vector
+        # @param value [ Array<Symbol> ] Array of flags to encode
+        #
+        # @return [ String ] Buffer that received the serialized vector
         def serialize(buffer, value)
           bits = 0
           value.each { |flag| bits |= @masks[flag] }
@@ -45,8 +46,9 @@ def serialize(buffer, value)
 
         # Deserializes vector by decoding the symbol according to its mask
         #
-        # @param io [IO] Stream containing the vector to be deserialized
-        # @return [Array<Symbol>] Flags contained in the vector
+        # @param [ String ] buffer Buffer containing the vector to be deserialized.
+        #
+        # @return [ Array<Symbol> ] Flags contained in the vector
         def deserialize(buffer)
           vector = buffer.get_int32
           flags = []

lib/mongo/protocol/serializers.rb

@@ -46,17 +46,19 @@ module Header
 
         # Serializes the header value into the buffer
         #
-        # @param buffer [String] Buffer to receive the serialized value.
-        # @param value [String] Header value to be serialized.
-        # @return [String] Buffer with serialized value.
+        # @param buffer [ String ] Buffer to receive the serialized value.
+        # @param value [ String ] Header value to be serialized.
+        #
+        # @return [ String ] Buffer with serialized value.
         def self.serialize(buffer, value)
           buffer.put_bytes(value.pack(HEADER_PACK))
         end
 
         # Deserializes the header value from the IO stream
         #
-        # @param io [IO] IO stream containing the message header.
-        # @return [Array<Fixnum>] Array consisting of the deserialized
+        # @param [ String ] buffer Buffer containing the message header.
+        #
+        # @return [ Array<Fixnum> ] Array consisting of the deserialized
         #   length, request id, response id, and op code.
         def self.deserialize(buffer)
           buffer.get_bytes(16).unpack(HEADER_PACK)
@@ -70,9 +72,10 @@ module CString
 
         # Serializes a C style string into the buffer
         #
-        # @param buffer [String] Buffer to receive the serialized CString.
-        # @param value [String] The string to be serialized.
-        # @return [String] Buffer with serialized value.
+        # @param buffer [ String ] Buffer to receive the serialized CString.
+        # @param value [ String ] The string to be serialized.
+        #
+        # @return [ String ] Buffer with serialized value.
         def self.serialize(buffer, value)
           buffer.put_cstring(value)
         end
@@ -85,9 +88,10 @@ module Zero
 
         # Serializes a 32-bit Zero into the buffer
         #
-        # @param buffer [String] Buffer to receive the serialized Zero.
-        # @param value [Fixnum] Ignored value.
-        # @return [String] Buffer with serialized value.
+        # @param buffer [ String ] Buffer to receive the serialized Zero.
+        # @param value [ Fixnum ] Ignored value.
+        #
+        # @return [ String ] Buffer with serialized value.
         def self.serialize(buffer, value)
           buffer.put_int32(ZERO)
         end
@@ -100,17 +104,19 @@ module Int32
 
         # Serializes a fixnum to a 4-byte 32-bit integer
         #
-        # @param buffer [String] Buffer to receive the serialized Int32.
-        # @param value [Fixnum] 32-bit integer to be serialized.
+        # @param buffer [ String ] Buffer to receive the serialized Int32.
+        # @param value [ Fixnum ] 32-bit integer to be serialized.
+        #
         # @return [String] Buffer with serialized value.
         def self.serialize(buffer, value)
           buffer.put_int32(value)
         end
 
         # Deserializes a 32-bit Fixnum from the IO stream
         #
-        # @param io [IO] IO stream containing the 32-bit integer
-        # @return [Fixnum] Deserialized Int32
+        # @param [ String ] buffer Buffer containing the 32-bit integer
+        #
+        # @return [ Fixnum ] Deserialized Int32
         def self.deserialize(buffer)
           buffer.get_int32
         end
@@ -123,16 +129,18 @@ module Int64
 
         # Serializes a fixnum to an 8-byte 64-bit integer
         #
-        # @param buffer [String] Buffer to receive the serialized Int64.
-        # @param value [Fixnum] 64-bit integer to be serialized.
-        # @return [String] Buffer with serialized value.
+        # @param buffer [ String ] Buffer to receive the serialized Int64.
+        # @param value [ Fixnum ] 64-bit integer to be serialized.
+        #
+        # @return [ String ] Buffer with serialized value.
         def self.serialize(buffer, value)
           buffer.put_int64(value)
         end
 
         # Deserializes a 64-bit Fixnum from the IO stream
         #
-        # @param io [IO] IO stream containing the 64-bit integer.
+        # @param [ String ] buffer Buffer containing the 64-bit integer.
+        #
         # @return [Fixnum] Deserialized Int64.
         def self.deserialize(buffer)
           buffer.get_int64
@@ -146,9 +154,10 @@ module Document
 
         # Serializes a document into the buffer
         #
-        # @param buffer [String] Buffer to receive the BSON encoded document.
-        # @param value [Hash] Document to serialize as BSON.
-        # @return [String] Buffer with serialized value.
+        # @param buffer [ String ] Buffer to receive the BSON encoded document.
+        # @param value [ Hash ] Document to serialize as BSON.
+        #
+        # @return [ String ] Buffer with serialized value.
         def self.serialize(buffer, value, max_bson_size = nil)
           start_size = buffer.length
           value.to_bson(buffer)
@@ -159,8 +168,9 @@ def self.serialize(buffer, value, max_bson_size = nil)
 
         # Deserializes a document from the IO stream
         #
-        # @param io [IO] IO stream containing the BSON encoded document.
-        # @return [Hash] The decoded BSON document.
+        # @param [ String ] buffer Buffer containing the BSON encoded document.
+        #
+        # @return [ Hash ] The decoded BSON document.
         def self.deserialize(buffer)
           BSON::Document.from_bson(buffer)
         end