class RuboCop::Cop::Style::DocumentationMethod

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

@example RequireForNonPublicMethods: false (default)

# good
class Foo
  protected
  def do_something
  end
end

class Foo
  private
  def do_something
  end
end

@example RequireForNonPublicMethods: true

# bad
class Foo
  protected
  def do_something
  end
end

class Foo
  private
  def do_something
  end
end

# good
class Foo
  protected
  # Documentation
  def do_something
  end
end

class Foo
  private
  # Documentation
  def do_something
  end
end

Constants

MSG

Public Instance Methods

on_def(node) click to toggle source
# File lib/rubocop/cop/style/documentation_method.rb, line 105
def on_def(node)
  parent = node.parent
  module_function_node?(parent) ? check(parent) : check(node)
end
Also aliased as: on_defs
on_defs(node)
Alias for: on_def

Private Instance Methods

check(node) click to toggle source
# File lib/rubocop/cop/style/documentation_method.rb, line 113
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 120
def require_for_non_public_methods?
  cop_config['RequireForNonPublicMethods']
end