Add YARD docs for Faker::DcComics (#1913)

* Add YARD docs for Faker::DcComics

Signed-off-by: Aswin Muthu Kumar <ashelangovan97@gmail.com>

* Minor doc update

Signed-off-by: Aswin Muthu Kumar <ashelangovan97@gmail.com>

* Update lib/faker/default/dc_comics.rb

Co-Authored-By: Connor Shea <connor.james.shea@gmail.com>

* Update lib/faker/default/dc_comics.rb

Co-Authored-By: Connor Shea <connor.james.shea@gmail.com>

* Update lib/faker/default/dc_comics.rb

Co-Authored-By: Connor Shea <connor.james.shea@gmail.com>

* Update lib/faker/default/dc_comics.rb

Co-Authored-By: Connor Shea <connor.james.shea@gmail.com>

* Update lib/faker/default/dc_comics.rb

Co-Authored-By: Connor Shea <connor.james.shea@gmail.com>

Co-authored-by: Vitor Oliveira <vbrazo@gmail.com>
Co-authored-by: Connor Shea <connor.james.shea@gmail.com>

lib/faker/default/dc_comics.rb

@@ -2,22 +2,67 @@
 
 module Faker
   class DcComics < Base
+    ##
+    # Produces a hero name from DC Comics
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::DcComics.hero #=> "Batman"
+    #
+    # @faker.version 1.9.2
     def self.hero
       fetch('dc_comics.hero')
     end
 
+    ##
+    # Produces a heroine name from DC Comics
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::DcComics.heroine #=> "Supergirl"
+    #
+    # @faker.version 1.9.2
     def self.heroine
       fetch('dc_comics.heroine')
     end
 
+    ##
+    # Produces a villain name from DC Comics
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::DcComics.villain #=> "The Joker"
+    #
+    # @faker.version 1.9.2
     def self.villain
       fetch('dc_comics.villain')
     end
 
+    ##
+    # Produces a character name from DC Comics
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::DcComics.name #=> "Clark Kent"
+    #
+    # @faker.version 1.9.2
     def self.name
       fetch('dc_comics.name')
     end
 
+    ##
+    # Produces a comic book title from DC Comics
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::DcComics.title #=> "Batman: The Long Halloween"
+    #
+    # @faker.version 1.9.2
     def self.title
       fetch('dc_comics.title')
     end