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, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a “#:nodoc:” comment next to it. Likewise, “#:nodoc: all” does the same for all its children.

Constant Summary collapse

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

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_class(node) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/rubocop/cop/style/documentation.rb', line 22

def on_class(node)
  _name, _superclass, body = *node
  return unless body
  return if namespace?(body)

  ast_with_comments = processed_source.ast_with_comments
  return if associated_comment?(node, ast_with_comments)
  return if nodoc_comment?(node, ast_with_comments)
  add_offense(node, :keyword, format(MSG, :class))
end

#on_module(node) ⇒ Object 



33
34
35
36
37
38
39
40
41
 
# File 'lib/rubocop/cop/style/documentation.rb', line 33

def on_module(node)
  _name, body = *node
  return if namespace?(body)

  ast_with_comments = processed_source.ast_with_comments
  return if associated_comment?(node, ast_with_comments)
  return if nodoc_comment?(node, ast_with_comments)
  add_offense(node, :keyword, format(MSG, :module))
end