Contents

module YARD  #:nodoc: all
  module CodeObjects
    class MethodObject

      # Return the docstring associated with the method
      #
      # @example
      #   method_object.docstring  # => YARD::Docstring instance
      #
      # @return [YARD::Docstring]
      #   the docstring for this method
      #
      # @api public
      def docstring
        # TODO: update to use super() once reek does not flag it as
        #   a utility method
        @docstring.extend(Yardstick::Method)
      end

      # TODO: create an object to wrap tags, and extend each tag object with
      # the matching module, if one exists under Yardstick::Tag::*

    end # class MethodObject
  end # module CodeObjects
end # module YARD

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
dkubb-yardstick-0.0.1	lib/yardstick/yard_ext.rb
dkubb-yardstick-0.1.0	lib/yardstick/yard_ext.rb