Class: Rubocop::Cop::Style::Documentation

Inherits:
Cop
  • Object
show all
Includes:
AnnotationComment
Defined in:
lib/rubocop/cop/style/documentation.rb

Overview

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.

Constant Summary collapse

MSG = 
'Missing top-level %s documentation comment.'

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #debug?, #display_cop_names?, #exclude_file?, #include_file?, inherited, #initialize, lint?, #message, non_rails, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes

Methods included from PathUtil

match_path?, relative_path

Constructor Details

This class inherits a constructor from Rubocop::Cop::Cop

Instance Method Details

#investigate(processed_source) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/rubocop/cop/style/documentation.rb', line 15

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