Fix style of YARD @return tag description
Before there was lots of redundant information. These comments where very old and my current YARD doc style changed in the meantime. Keep it DRY.
This commit is contained in:
parent
1e2983cbbf
commit
dfcabdc279
9 changed files with 16 additions and 20 deletions
|
@ -19,7 +19,7 @@ module Mutant
|
||||||
# @param [Array<String>] arguments
|
# @param [Array<String>] arguments
|
||||||
#
|
#
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
# returns exit status
|
# the exit status
|
||||||
#
|
#
|
||||||
# @api private
|
# @api private
|
||||||
#
|
#
|
||||||
|
|
|
@ -36,7 +36,7 @@ module Mutant
|
||||||
# @param [String] text
|
# @param [String] text
|
||||||
#
|
#
|
||||||
# @return [String]
|
# @return [String]
|
||||||
# returns the argument string
|
# the argument string
|
||||||
#
|
#
|
||||||
# @api private
|
# @api private
|
||||||
#
|
#
|
||||||
|
|
|
@ -108,7 +108,6 @@ module Mutant
|
||||||
# @param [String] line
|
# @param [String] line
|
||||||
#
|
#
|
||||||
# @return [String]
|
# @return [String]
|
||||||
# returns colorized line
|
|
||||||
#
|
#
|
||||||
# @api private
|
# @api private
|
||||||
#
|
#
|
||||||
|
|
|
@ -9,10 +9,10 @@ module Mutant
|
||||||
# Enumerate subjects
|
# Enumerate subjects
|
||||||
#
|
#
|
||||||
# @return [Enumerator<Subject]
|
# @return [Enumerator<Subject]
|
||||||
# returns subject enumerator if no block given
|
# if no block given
|
||||||
#
|
#
|
||||||
# @return [self]
|
# @return [self]
|
||||||
# returnns self otherwise
|
# otherwise
|
||||||
#
|
#
|
||||||
# @api private
|
# @api private
|
||||||
#
|
#
|
||||||
|
|
|
@ -14,10 +14,10 @@ module Mutant
|
||||||
# Enumerate matches
|
# Enumerate matches
|
||||||
#
|
#
|
||||||
# @return [Enumerable<Subject>]
|
# @return [Enumerable<Subject>]
|
||||||
# returns enumerable when no block given
|
# if no block given
|
||||||
#
|
#
|
||||||
# @return [self]
|
# @return [self]
|
||||||
# returns self when block given
|
# otherwise
|
||||||
#
|
#
|
||||||
# @api private
|
# @api private
|
||||||
#
|
#
|
||||||
|
@ -129,7 +129,7 @@ module Mutant
|
||||||
# Return subject
|
# Return subject
|
||||||
#
|
#
|
||||||
# @return [Subject]
|
# @return [Subject]
|
||||||
# returns subject if there is a matched node
|
# if there is a matched node
|
||||||
#
|
#
|
||||||
# @return [nil]
|
# @return [nil]
|
||||||
# otherwise
|
# otherwise
|
||||||
|
|
|
@ -45,10 +45,10 @@ module Mutant
|
||||||
# @param [Parser::AST::Node] node
|
# @param [Parser::AST::Node] node
|
||||||
#
|
#
|
||||||
# @return [true]
|
# @return [true]
|
||||||
# returns true if node matches method
|
# if node matches method
|
||||||
#
|
#
|
||||||
# @return [false]
|
# @return [false]
|
||||||
# returns false if node NOT matches method
|
# otherwise
|
||||||
#
|
#
|
||||||
# @api private
|
# @api private
|
||||||
#
|
#
|
||||||
|
|
|
@ -28,7 +28,7 @@ module Mutant
|
||||||
# when can be build from string
|
# when can be build from string
|
||||||
#
|
#
|
||||||
# @return [nil]
|
# @return [nil]
|
||||||
# returns nil otherwise
|
# otherwise
|
||||||
#
|
#
|
||||||
# @api private
|
# @api private
|
||||||
#
|
#
|
||||||
|
@ -46,7 +46,6 @@ module Mutant
|
||||||
# @param [String] _notation
|
# @param [String] _notation
|
||||||
#
|
#
|
||||||
# @return [nil]
|
# @return [nil]
|
||||||
# returns nil
|
|
||||||
#
|
#
|
||||||
# @api private
|
# @api private
|
||||||
#
|
#
|
||||||
|
@ -62,7 +61,6 @@ module Mutant
|
||||||
# @pram [Mutation] _mutation
|
# @pram [Mutation] _mutation
|
||||||
#
|
#
|
||||||
# @return [true]
|
# @return [true]
|
||||||
# returns true
|
|
||||||
#
|
#
|
||||||
# @api private
|
# @api private
|
||||||
#
|
#
|
||||||
|
|
|
@ -164,10 +164,10 @@ module Mutant
|
||||||
# Test for colored output
|
# Test for colored output
|
||||||
#
|
#
|
||||||
# @return [true]
|
# @return [true]
|
||||||
# returns true if output is colored
|
# if output is colored
|
||||||
#
|
#
|
||||||
# @return [false]
|
# @return [false]
|
||||||
# returns false otherwise
|
# otherwise
|
||||||
#
|
#
|
||||||
# @api private
|
# @api private
|
||||||
#
|
#
|
||||||
|
@ -183,8 +183,8 @@ module Mutant
|
||||||
# @api private
|
# @api private
|
||||||
#
|
#
|
||||||
# @return [String]
|
# @return [String]
|
||||||
# returns colorized string if color is enabled
|
# if color is enabled
|
||||||
# returns unmodified message otherwise
|
# unmodified message otherwise
|
||||||
#
|
#
|
||||||
def colorize(color, message)
|
def colorize(color, message)
|
||||||
color = Color::NONE unless tty?
|
color = Color::NONE unless tty?
|
||||||
|
@ -194,10 +194,10 @@ module Mutant
|
||||||
# Test for output to tty
|
# Test for output to tty
|
||||||
#
|
#
|
||||||
# @return [true]
|
# @return [true]
|
||||||
# returns true if output is a tty
|
# if output is a tty
|
||||||
#
|
#
|
||||||
# @return [false]
|
# @return [false]
|
||||||
# returns false otherwise
|
# otherwise
|
||||||
#
|
#
|
||||||
# @api private
|
# @api private
|
||||||
#
|
#
|
||||||
|
|
|
@ -23,7 +23,6 @@ module Mutant
|
||||||
# Not aliased to prevent problems from inheritance
|
# Not aliased to prevent problems from inheritance
|
||||||
#
|
#
|
||||||
# @return [Objecct]
|
# @return [Objecct]
|
||||||
# returns the created object
|
|
||||||
#
|
#
|
||||||
# @api private
|
# @api private
|
||||||
#
|
#
|
||||||
|
|
Loading…
Add table
Reference in a new issue