Class: RuboCop::Cop::Yardoc::Base::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



11
12
13
 
# File 'lib/rubocop/cop/yardoc/base.rb', line 11

def blank
  @blank
end

#comment ⇒ Object

Returns the value of attribute comment

Returns:

  • (Object) —

    the current value of comment



11
12
13
 
# File 'lib/rubocop/cop/yardoc/base.rb', line 11

def comment
  @comment
end

#line ⇒ Object

Returns the value of attribute line

Returns:

  • (Object) —

    the current value of line



11
12
13
 
# File 'lib/rubocop/cop/yardoc/base.rb', line 11

def line
  @line
end

#tag ⇒ Object

Returns the value of attribute tag

Returns:

  • (Object) —

    the current value of tag



11
12
13
 
# File 'lib/rubocop/cop/yardoc/base.rb', line 11

def tag
  @tag
end

#text ⇒ Object

Returns the value of attribute text

Returns:

  • (Object) —

    the current value of text



11
12
13
 
# File 'lib/rubocop/cop/yardoc/base.rb', line 11

def text
  @text
end

Instance Method Details

#blank? ⇒ Boolean

Whether the comment is empty

Returns:

  • (Boolean) 


15
16
17
 
# File 'lib/rubocop/cop/yardoc/base.rb', line 15

def blank?
  blank
end