Added YARD tags to Countries.

postmodern · Dec 3, 2009 · 3b1a99f · 3b1a99f
1 parent 3ed4de4
commit 3b1a99f
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/lib/shodan/countries.rb b/lib/shodan/countries.rb
@@ -264,8 +264,16 @@ module Countries
     CentralAfricanRepublic = 'CF'
 
     #
-    # Iterates over every Country Code, passing ech one to the given
-    # _block_.
+    # Iterates over every Country Code.
+    #
+    # @yield [country]
+    #   The given block will receive every Country Code.
+    #
+    # @yieldparam [String] country
+    #   The ISO 3166-1993 Country Code.
+    #
+    # @return [Countries]
+    #   The Countries module.
     #
     def Countries.each(&block)
       self.constants.each do |name|