Add YARD docs for Faker::BossaNova. (faker-ruby#1849)

davidmorton0 · Dec 6, 2019 · 72173c8 · 72173c8
1 parent e6ca063
commit 72173c8
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/lib/faker/default/bossa_nova.rb b/lib/faker/default/bossa_nova.rb
@@ -3,10 +3,28 @@
 module Faker
   class BossaNova < Base
     class << self
+      ##
+      # Produces the name of a bossa nova artist.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::BossaNova.artist #=> "Tom Jobin"
+      #
+      # @faker.version 1.8.3
       def artist
         fetch('bossa_nova.artists')
       end
 
+      ##
+      # Produces a bossa nova song.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::BossaNova.song #=> "Chega de Saudade"
+      #
+      # @faker.version 1.8.3
       def song
         fetch('bossa_nova.songs')
       end