dkubb/yardstick

View on GitHub
lib/yardstick/rules/return_tag.rb

Summary

Maintainability
A
0 mins
Test Coverage
# encoding: utf-8

module Yardstick
  module Rules
    # Checks if method has a @return tag
    #
    class ReturnTag < Rule
      describe '*@return* should be specified'.freeze

      # @see class description
      #
      # @return [Boolean]
      #   true if has return tag
      #
      # @api private
      def valid?
        has_tag?('return')
      end
    end
  end
end