module RuboCop::Cop::DocumentationComment
def documentation_comment?(node)
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
def interpreter_directive_comment?(comment)
def interpreter_directive_comment?(comment) comment.text =~ /^#\s*(frozen_string_literal|encoding):/ end
def precede?(node1, node2)
The args node1 & node2 may represent a RuboCop::AST::Node
def precede?(node1, node2) node2.loc.line - node1.loc.line == 1 end
def preceding_comment?(node1, node2)
The args node1 & node2 may represent a RuboCop::AST::Node
def preceding_comment?(node1, node2) node1 && node2 && precede?(node2, node1) && comment_line?(node2.loc.expression.source) end
def preceding_lines(node)
def preceding_lines(node) processed_source.ast_with_comments[node].select do |line| line.loc.line < node.loc.line end end
def rubocop_directive_comment?(comment)
def rubocop_directive_comment?(comment) comment.text =~ CommentConfig::COMMENT_DIRECTIVE_REGEXP end