Fix YARD docs

This commit is contained in:
Markus Schirp 2014-06-28 20:52:47 +00:00
parent 0bfe69bdaa
commit d46f702d82
14 changed files with 39 additions and 3 deletions

View file

@ -1,3 +1,3 @@
---
threshold: 18
total_score: 899
total_score: 919

View file

@ -37,6 +37,8 @@ module Mutant
#
# @param [Class,Module] host
#
# @return [undefined]
#
# @api private
#
def self.included(host)

View file

@ -51,6 +51,8 @@ module Mutant
#
# @return [self]
#
# @api private
#
def source(input)
raise 'source already defined' if @source
@source = node(input)
@ -64,6 +66,8 @@ module Mutant
#
# @return [self]
#
# @api private
#
def mutation(input)
node = node(input)
if @expected.include?(node)

View file

@ -13,6 +13,8 @@ module Mutant
#
# @return [self]
#
# @api private
#
def self.run(output, object)
handler = lookup(object.class)
handler.new(output, object).run

View file

@ -11,6 +11,8 @@ module Mutant
#
# @return [self]
#
# @api private
#
def run
self
end

View file

@ -58,6 +58,8 @@ module Mutant
#
# @return [undefined]
#
# @api private
#
def included(host)
object = self
host.class_eval do

View file

@ -20,6 +20,8 @@ module Mutant
#
# @return [self]
#
# @api private
#
def report(object)
report_calls << object
self
@ -31,6 +33,8 @@ module Mutant
#
# @return [self]
#
# @api private
#
def progress(object)
progress_calls << object
self

View file

@ -15,7 +15,7 @@ module Mutant
#
# @return [self]
#
# @api pivate
# @api private
#
def run
infect
@ -29,7 +29,7 @@ module Mutant
#
# @return [self]
#
# @api pivate
# @api private
#
def infect
callback = @callback

View file

@ -25,6 +25,8 @@ module Mutant
#
# @param [Rspec::Test] test
#
# @return [Test::Report]
#
# @api private
#
def run(test)

View file

@ -57,6 +57,8 @@ module Mutant
#
# @return [Boolean]
#
# @api private
#
def running?
@running
end

View file

@ -28,6 +28,7 @@ module Mutant
# @return [Boolean]
#
# @api private
#
def success?
@report.success?
end
@ -36,6 +37,8 @@ module Mutant
#
# @return [Boolean]
#
# @api private
#
def mutation_dead?
test_report = report.test_report
killer.mutation.should_fail? && test_report.failed?
@ -59,6 +62,8 @@ module Mutant
# Run killer
#
# @return [undefined]
#
# @api private
#
def run

View file

@ -11,6 +11,12 @@ module Mutant
:success
)
# Test if test was successful
#
# @return [Boolean]
#
# @api private
#
alias_method :success?, :success
# Test if test failed

View file

@ -45,6 +45,8 @@ module Mutant
#
# @return [self]
#
# @api private
#
def write(message)
if WARNING_PATTERN =~ message
warnings << message

View file

@ -34,10 +34,13 @@ module Mutant
# @param [String] logical_name
# @param [Symbol] namespace
#
# @return [self]
#
# @api private
#
def self.run(logical_name, namespace)
new(namespace).run(logical_name)
self
end
# Run zombifier