Parent

Methods

Files

Class/Module Index [+]

Quicksearch

RuboCop::Cop::Style::Documentation

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes or other other modules.

Constants

MSG

Public Instance Methods

investigate(processed_source) click to toggle source
# File lib/rubocop/cop/style/documentation.rb, line 14
def investigate(processed_source)
  ast = processed_source.ast
  return unless ast

  ast_with_comments = Parser::Source::Comment.associate(
    ast,
    processed_source.comments
  )

  check(ast, ast_with_comments)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.