Fix YARD docs

This commit is contained in:
Dan Kubb 2013-07-28 15:19:01 -07:00
parent 7ff35cc7b2
commit f78418bdb5
3 changed files with 10 additions and 6 deletions

View file

@ -30,9 +30,9 @@ module Mutant
killer.killed?
end
# Indicate if a killer should treat a kill as problematic.
# Indicate if a killer should treat a kill as problematic
#
# @return [false] Killing evil mutants is not problematic.
# @return [false] Killing evil mutants is not problematic
#
# @api private
#

View file

@ -10,12 +10,12 @@ module Mutant
SYMBOL = 'noop'
# Indicate if a killer should treat a kill as problematic.
# Indicate if a killer should treat a kill as problematic
#
# @return [false] Killing noop mutants is a serious problem. Failures
# in noop may indicate a broken test suite, but they can also be an
# indication mutant has altered the runtime environment in a subtle
# way and tickled an odd bug.
# way and tickled an odd bug
#
# @api private
#
@ -52,9 +52,9 @@ module Mutant
!killer.killed?
end
# Indicate if a killer should treat a kill as problematic.
# Indicate if a killer should treat a kill as problematic
#
# @return [true] Neutral mutants must die.
# @return [true] Neutral mutants must die
#
# @api private
#

View file

@ -56,6 +56,8 @@ module Mutant
# Assert the node type is valid
#
# @return [undefined]
#
# @raise [InvalidTypeError]
# raised when the node type is invalid
#
@ -70,6 +72,8 @@ module Mutant
# Assert the node type is unique and not already registered
#
# @return [undefined]
#
# @raise [DuplcateTypeError]
# raised when the node type is a duplicate
#