lib/chunky_png/datastream.rb in chunky_png-0.5.3 vs lib/chunky_png/datastream.rb in chunky_png-0.5.4

@@ -42,13 +42,13 @@
     def initialize
       @other_chunks = []
       @data_chunks  = []
     end
 
-    #############################################
+    ##############################################################################
     # LOADING DATASTREAMS
-    #############################################
+    ##############################################################################
 
     class << self
 
       # Reads a PNG datastream from a string.
       # @param [String] str The PNG encoded string to load from.
@@ -100,20 +100,21 @@
         signature = io.read(ChunkyPNG::Datastream::SIGNATURE.length)
         raise "PNG signature not found!" unless signature == ChunkyPNG::Datastream::SIGNATURE
       end
     end
 
-    #############################################
+    ##################################################################################
     # CHUNKS
-    #############################################
+    ##################################################################################
 
     # Enumerates the chunks in this datastream.
     #
     # This will iterate over the chunks using the order in which the chunks
     # should appear in the PNG file.
     #
-    # @yield [ChunkyPNG::Chunk::Base] The chunks in this datastrean, one by one.
+    # @yield [chunk] Yields the chunks in this datastrean, one by one in the correct order.
+    # @yieldparam [ChunkyPNG::Chunk::Base] chunk A chunk in this datastream.
     # @see ChunkyPNG::Datastream#chunks
     def each_chunk
       yield(header_chunk)
       other_chunks.each { |chunk| yield(chunk) }
       yield(palette_chunk)      if palette_chunk
@@ -136,12 +137,12 @@
         metadata[chunk.keyword] = chunk.value if chunk.respond_to?(:keyword)
       end
       metadata
     end
 
-    #############################################
+    ##################################################################################
     # WRITING DATASTREAMS
-    #############################################
+    ##################################################################################
 
     # Writes the datastream to the given output stream.
     # @param [IO] io The output stream to write to.
     def write(io)
       io << SIGNATURE