class RuboCop::Cop::Style::DocumentationMethod


end
end
def do_something
# Documentation
private
class Foo
end
end
def do_something
# Documentation
protected
class Foo
# good
end
end
def do_something
private
class Foo
end
end
def do_something
protected
class Foo
# bad
@example RequireForNonPublicMethods: true
end
end
def do_something
private
class Foo
end
end
def do_something
protected
class Foo
# good
@example RequireForNonPublicMethods: false (default)
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
they are called constructor to distinguish it from method.
a special method called from ‘new`. In some programming languages
NOTE: This cop allows `initialize` method because `initialize` is
non-public methods.
It can optionally be configured to also require documentation for
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)
  return if node.method?(:initialize)
  parent = node.parent
  modifier_node?(parent) ? check(parent) : check(node)
end

def require_for_non_public_methods? 

def require_for_non_public_methods?
  cop_config['RequireForNonPublicMethods']
end