Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add YARD docs for Faker::DcComics #1913

Merged
merged 7 commits into from
Feb 15, 2020
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
45 changes: 45 additions & 0 deletions lib/faker/default/dc_comics.rb
Expand Up @@ -2,22 +2,67 @@

module Faker
class DcComics < Base
##
# Produces a hero name from DC comics
vbrazo marked this conversation as resolved.
Show resolved Hide resolved
#
# @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
vbrazo marked this conversation as resolved.
Show resolved Hide resolved
#
# @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
vbrazo marked this conversation as resolved.
Show resolved Hide resolved
#
# @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
vbrazo marked this conversation as resolved.
Show resolved Hide resolved
#
# @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
vbrazo marked this conversation as resolved.
Show resolved Hide resolved
#
# @return [String]
#
# @example
# Faker::DcComics.title #=> "Batman: The Long Halloween"
#
# @faker.version 1.9.2
def self.title
fetch('dc_comics.title')
end
Expand Down