From 5fdaf9de15d4bfc51efb699590189368e1631bce Mon Sep 17 00:00:00 2001 From: Markus Schirp Date: Sun, 15 Jun 2014 19:27:57 +0000 Subject: [PATCH] Kill redundant YARD docs --- lib/mutant/matcher/method.rb | 8 ++----- lib/mutant/matcher/method/instance.rb | 6 +----- lib/mutant/matcher/method/singleton.rb | 30 +++++--------------------- lib/mutant/mutation.rb | 6 +----- lib/mutant/mutation/evil.rb | 6 +----- lib/mutant/mutator.rb | 5 +---- lib/mutant/mutator/node/argument.rb | 6 +----- lib/mutant/mutator/util.rb | 6 +----- lib/mutant/reporter/cli/printer.rb | 20 ++++------------- lib/mutant/runner.rb | 12 ++--------- lib/mutant/runner/config.rb | 6 +----- lib/mutant/runner/mutation.rb | 6 +----- lib/mutant/runner/subject.rb | 6 +----- lib/mutant/subject/method.rb | 6 +----- lib/mutant/subject/method/instance.rb | 6 +----- lib/mutant/subject/method/singleton.rb | 6 +----- 16 files changed, 25 insertions(+), 116 deletions(-) diff --git a/lib/mutant/matcher/method.rb b/lib/mutant/matcher/method.rb index adbe290a..280cd37d 100644 --- a/lib/mutant/matcher/method.rb +++ b/lib/mutant/matcher/method.rb @@ -31,13 +31,9 @@ module Mutant private - # Test if method is skipped + # Test if method should be skipped # - # @return [true] - # true and print warning if location must be filtered - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # diff --git a/lib/mutant/matcher/method/instance.rb b/lib/mutant/matcher/method/instance.rb index 46bab1ce..c0cad37b 100644 --- a/lib/mutant/matcher/method/instance.rb +++ b/lib/mutant/matcher/method/instance.rb @@ -42,11 +42,7 @@ module Mutant # # @param [Parser::AST::Node] node # - # @return [true] - # if node matches method - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # diff --git a/lib/mutant/matcher/method/singleton.rb b/lib/mutant/matcher/method/singleton.rb index 54f0a00e..d891097d 100644 --- a/lib/mutant/matcher/method/singleton.rb +++ b/lib/mutant/matcher/method/singleton.rb @@ -26,11 +26,7 @@ module Mutant # # @param [Parser::AST::Node] node # - # @return [true] - # if node matches method - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # @@ -42,11 +38,7 @@ module Mutant # # @param [Parser::AST::Node] node # - # @return [true] - # if node matches source line - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # @@ -60,11 +52,7 @@ module Mutant # # @param [Parser::AST::Node] node # - # @return [true] - # if node name matches - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # @@ -76,11 +64,7 @@ module Mutant # # @param [Parser::AST::Node] node # - # @return [true] - # when receiver matches - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # @@ -105,11 +89,7 @@ module Mutant # # @param [Parser::AST::Node] node # - # @return [true] - # if node name matches unqualified scope name - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # diff --git a/lib/mutant/mutation.rb b/lib/mutant/mutation.rb index 6a786a28..30210e02 100644 --- a/lib/mutant/mutation.rb +++ b/lib/mutant/mutation.rb @@ -22,11 +22,7 @@ module Mutant # # @param [Killer] killer # - # @return [true] - # if killer is successful - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # diff --git a/lib/mutant/mutation/evil.rb b/lib/mutant/mutation/evil.rb index 37a380c0..8f2a33be 100644 --- a/lib/mutant/mutation/evil.rb +++ b/lib/mutant/mutation/evil.rb @@ -10,11 +10,7 @@ module Mutant # # @param [Killer] killer # - # @return [true] - # if killer killed mutation - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # diff --git a/lib/mutant/mutator.rb b/lib/mutant/mutator.rb index 66b9c14b..66b8c497 100644 --- a/lib/mutant/mutator.rb +++ b/lib/mutant/mutator.rb @@ -73,10 +73,7 @@ module Mutant # # @param [Object] object # - # @return [true] - # if generated object is different - # - # @return [false] + # @return [Boolean] # # @api private # diff --git a/lib/mutant/mutator/node/argument.rb b/lib/mutant/mutator/node/argument.rb index 0d927c48..66c7ae6c 100644 --- a/lib/mutant/mutator/node/argument.rb +++ b/lib/mutant/mutator/node/argument.rb @@ -37,11 +37,7 @@ module Mutant # Test if argument mutation is skipped # - # @return [true] - # if argument should not get mutated - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # diff --git a/lib/mutant/mutator/util.rb b/lib/mutant/mutator/util.rb index 738663f8..325f40d7 100644 --- a/lib/mutant/mutator/util.rb +++ b/lib/mutant/mutator/util.rb @@ -30,11 +30,7 @@ module Mutant # # @param [Object] generated # - # @return [true] - # if object is new - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # diff --git a/lib/mutant/reporter/cli/printer.rb b/lib/mutant/reporter/cli/printer.rb index 9a3d4f58..49e7f10d 100644 --- a/lib/mutant/reporter/cli/printer.rb +++ b/lib/mutant/reporter/cli/printer.rb @@ -83,11 +83,7 @@ module Mutant # Test if runner was successful # - # @return [true] - # if runner is successful - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # @@ -95,13 +91,9 @@ module Mutant object.success? end - # Test for colored output + # Test if output can be colored # - # @return [true] - # if output is colored - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # @@ -127,11 +119,7 @@ module Mutant # Test for output to tty # - # @return [true] - # if output is a tty - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # diff --git a/lib/mutant/runner.rb b/lib/mutant/runner.rb index e2db63c8..cb28980b 100644 --- a/lib/mutant/runner.rb +++ b/lib/mutant/runner.rb @@ -91,11 +91,7 @@ module Mutant # Test if runner should stop # - # @return [true] - # if runner should stop - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # @@ -115,11 +111,7 @@ module Mutant # Test if runner is successful # - # @return [true] - # if successful - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # diff --git a/lib/mutant/runner/config.rb b/lib/mutant/runner/config.rb index 64192b34..e17f98a3 100644 --- a/lib/mutant/runner/config.rb +++ b/lib/mutant/runner/config.rb @@ -43,11 +43,7 @@ module Mutant # Test if run was successful # - # @return [true] - # if run was successful - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # diff --git a/lib/mutant/runner/mutation.rb b/lib/mutant/runner/mutation.rb index 1de31a84..53d5641d 100644 --- a/lib/mutant/runner/mutation.rb +++ b/lib/mutant/runner/mutation.rb @@ -40,11 +40,7 @@ module Mutant # Test if mutation was handeled successfully # - # @return [true] - # if successful - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # diff --git a/lib/mutant/runner/subject.rb b/lib/mutant/runner/subject.rb index d58dbafd..8c949b9f 100644 --- a/lib/mutant/runner/subject.rb +++ b/lib/mutant/runner/subject.rb @@ -49,11 +49,7 @@ module Mutant # Test if subject was processed successful # - # @return [true] - # if successful - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # diff --git a/lib/mutant/subject/method.rb b/lib/mutant/subject/method.rb index 230ff2eb..eb54d42d 100644 --- a/lib/mutant/subject/method.rb +++ b/lib/mutant/subject/method.rb @@ -5,11 +5,7 @@ module Mutant # Test if method is public # - # @return [true] - # if method is public - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # diff --git a/lib/mutant/subject/method/instance.rb b/lib/mutant/subject/method/instance.rb index c16548a9..0b1de410 100644 --- a/lib/mutant/subject/method/instance.rb +++ b/lib/mutant/subject/method/instance.rb @@ -9,11 +9,7 @@ module Mutant # Test if method is public # - # @return [true] - # if method is public - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private # diff --git a/lib/mutant/subject/method/singleton.rb b/lib/mutant/subject/method/singleton.rb index de5cb046..a5dc1690 100644 --- a/lib/mutant/subject/method/singleton.rb +++ b/lib/mutant/subject/method/singleton.rb @@ -9,11 +9,7 @@ module Mutant # Test if method is public # - # @return [true] - # if method is public - # - # @return [false] - # otherwise + # @return [Boolean] # # @api private #