module RuboCop::Cop::DocumentationComment
Common functionality for checking documentation.
Private Instance Methods
documentation_comment?(node)
click to toggle source
# File lib/rubocop/cop/mixin/documentation_comment.rb, line 14 def documentation_comment?(node) preceding_lines = preceding_lines(node) return false unless preceding_comment?(node, preceding_lines.last) preceding_lines.any? do |comment| !annotation?(comment) && !interpreter_directive_comment?(comment) && !rubocop_directive_comment?(comment) end end
interpreter_directive_comment?(comment)
click to toggle source
# File lib/rubocop/cop/mixin/documentation_comment.rb, line 37 def interpreter_directive_comment?(comment) comment.text =~ /^#\s*(frozen_string_literal|encoding):/ end
preceding_comment?(n1, n2)
click to toggle source
# File lib/rubocop/cop/mixin/documentation_comment.rb, line 26 def preceding_comment?(n1, n2) n1 && n2 && preceed?(n2, n1) && comment_line?(n2.loc.expression.source) end
preceding_lines(node)
click to toggle source
# File lib/rubocop/cop/mixin/documentation_comment.rb, line 31 def preceding_lines(node) processed_source.ast_with_comments[node].select do |line| line.loc.line < node.loc.line end end
rubocop_directive_comment?(comment)
click to toggle source
# File lib/rubocop/cop/mixin/documentation_comment.rb, line 41 def rubocop_directive_comment?(comment) comment.text =~ CommentConfig::COMMENT_DIRECTIVE_REGEXP end