Sha256: 89239826ccd5de7a553cbbf221484969d2c75d9279aeedc77e005929b8c9e0fa
Contents?: true
Size: 1.59 KB
Versions: 13
Compression:
Stored size: 1.59 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Style
# This cop checks for missing documentation comment for public methods.
# It can optionally be configured to also require documentation for
# non-public methods.
#
# @example
#
# # bad
#
# class Foo
# def bar
# puts baz
# end
# end
#
# module Foo
# def bar
# puts baz
# end
# end
#
# def foo.bar
# puts baz
# end
#
# # good
#
# class Foo
# # Documentation
# def bar
# puts baz
# end
# end
#
# module Foo
# # Documentation
# def bar
# puts baz
# end
# end
#
# # Documenation
# def foo.bar
# puts baz
# end
class DocumentationMethod < Cop
include DocumentationComment
include OnMethodDef
include DefNode
MSG = 'Missing method documentation comment.'.freeze
def on_def(node)
check(node)
end
def on_method_def(node, *)
check(node)
end
private
def check(node)
return if non_public?(node) && !require_for_non_public_methods?
return if documentation_comment?(node)
add_offense(node, :expression, MSG)
end
def require_for_non_public_methods?
cop_config['RequireForNonPublicMethods']
end
end
end
end
end
Version data entries
13 entries across 13 versions & 2 rubygems