Improve YARD documentation

This commit is contained in:
Markus Schirp 2014-06-10 02:13:15 +00:00
parent f1fe9561c5
commit e9061dc23a
3 changed files with 11 additions and 1 deletions

View file

@ -1,5 +1,7 @@
module Mutant module Mutant
# A simple delegator with opinions
module Delegator module Delegator
# Class level mixins
module ClassMethods module ClassMethods
private private

View file

@ -20,6 +20,9 @@ module Mutant
# Initialize expression # Initialize expression
# #
# @param [MatchData] match # @param [MatchData] match
#
# @api private
#
def initialize(*) def initialize(*)
super super
@syntax = match.to_s @syntax = match.to_s
@ -39,6 +42,8 @@ module Mutant
# #
# @return [Fixnum] # @return [Fixnum]
# #
# @api private
#
def match_length(neddle) def match_length(neddle)
if eql?(neddle) if eql?(neddle)
syntax.length syntax.length

View file

@ -5,7 +5,10 @@ module Mutant
# Run mutator on input # Run mutator on input
# #
# @param [Parser::AST::Node] node # @param [Object] input
# the input to mutate
#
# @param [Mutator] parent
# #
# @return [self] # @return [self]
# #