class RuboCop::Cop::Style::DocumentationMethod
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
Constants
- MSG
Public Instance Methods
on_def(node)
click to toggle source
# File lib/rubocop/cop/style/documentation_method.rb, line 60 def on_def(node) parent = node.parent module_function_node?(parent) ? check(parent) : check(node) end
Also aliased as: on_defs
Private Instance Methods
check(node)
click to toggle source
# File lib/rubocop/cop/style/documentation_method.rb, line 68 def check(node) return if non_public?(node) && !require_for_non_public_methods? return if documentation_comment?(node) add_offense(node) end
require_for_non_public_methods?()
click to toggle source
# File lib/rubocop/cop/style/documentation_method.rb, line 75 def require_for_non_public_methods? cop_config['RequireForNonPublicMethods'] end