Class: RuboCop::Cop::YardocBase::CommentEntry

Inherits:
Struct
  • Object
show all
Defined in:
lib/rubocop/cop/yardoc_base.rb

Overview

Represents a comment entry (it may be a multi-line comment)

Returns:

  • (Struct) —

    With :comment, :text, :tag, :line, :blank?

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#blank ⇒ Object

Returns the value of attribute blank

Returns:

  • (Object) —

    the current value of blank



10
11
12
 
# File 'lib/rubocop/cop/yardoc_base.rb', line 10

def blank
  @blank
end

#comment ⇒ Object

Returns the value of attribute comment

Returns:

  • (Object) —

    the current value of comment



10
11
12
 
# File 'lib/rubocop/cop/yardoc_base.rb', line 10

def comment
  @comment
end

#line ⇒ Object

Returns the value of attribute line

Returns:

  • (Object) —

    the current value of line



10
11
12
 
# File 'lib/rubocop/cop/yardoc_base.rb', line 10

def line
  @line
end

#tag ⇒ Object

Returns the value of attribute tag

Returns:

  • (Object) —

    the current value of tag



10
11
12
 
# File 'lib/rubocop/cop/yardoc_base.rb', line 10

def tag
  @tag
end

#text ⇒ Object

Returns the value of attribute text

Returns:

  • (Object) —

    the current value of text



10
11
12
 
# File 'lib/rubocop/cop/yardoc_base.rb', line 10

def text
  @text
end

Instance Method Details

#blank? ⇒ Boolean

Whether the comment is empty

Returns:

  • (Boolean) 


14
15
16
 
# File 'lib/rubocop/cop/yardoc_base.rb', line 14

def blank?
  blank
end