Sha256: 3e63438852539d3b7f28c7aa4f56e394ce51583476648bb878c18b96ab53de43
Contents?: true
Size: 1.7 KB
Versions: 6767
Compression:
Stored size: 1.7 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
#
# # Documentation
# def foo.bar
# puts baz
# end
class DocumentationMethod < Cop
include DocumentationComment
include DefNode
MSG = 'Missing method documentation comment.'.freeze
def_node_matcher :module_function_node?, <<-PATTERN
(send nil? :module_function ...)
PATTERN
def on_def(node)
parent = node.parent
module_function_node?(parent) ? check(parent) : check(node)
end
alias on_defs on_def
private
def check(node)
return if non_public?(node) && !require_for_non_public_methods?
return if documentation_comment?(node)
add_offense(node)
end
def require_for_non_public_methods?
cop_config['RequireForNonPublicMethods']
end
end
end
end
end
Version data entries
6,767 entries across 6,763 versions & 23 rubygems