class RuboCop::Cop::Style::DocumentationMethod
end
puts baz
def foo.bar
# Documentation
end
end
puts baz
def bar
# Documentation
module Foo
end
end
puts baz
def bar
# Documentation
class Foo
# good
end
puts baz
def foo.bar
end
end
puts baz
def bar
module Foo
end
end
puts baz
def bar
class Foo
# bad
@example
non-public methods.
It can optionally be configured to also require documentation for
This cop checks for missing documentation comment for public methods.
def check(node)
def check(node) return if non_public?(node) && !require_for_non_public_methods? return if documentation_comment?(node) add_offense(node) end
def on_def(node)
def on_def(node) parent = node.parent module_function_node?(parent) ? check(parent) : check(node) end
def require_for_non_public_methods?
def require_for_non_public_methods? cop_config['RequireForNonPublicMethods'] end