Class: Annotations::Extractor::Annotation

Inherits:
Struct
  • Object
show all
Defined in:
lib/annotations/extractor.rb

Overview

TODO: Test me

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#line ⇒ Object

Returns the value of attribute line

Returns:

  • (Object) —

    the current value of line



18
19
20
 
# File 'lib/annotations/extractor.rb', line 18

def line
  @line
end

#tag ⇒ Object

Returns the value of attribute tag

Returns:

  • (Object) —

    the current value of tag



18
19
20
 
# File 'lib/annotations/extractor.rb', line 18

def tag
  @tag
end

#text ⇒ Object

Returns the value of attribute text

Returns:

  • (Object) —

    the current value of text



18
19
20
 
# File 'lib/annotations/extractor.rb', line 18

def text
  @text
end

Instance Method Details

#to_s(options = {}) ⇒ Object

Returns a representation of the annotation that looks like this:

[126] [TODO] This algorithm is simple and clearly correct, make it faster.

If options has a flag :tag the tag is shown as in the example above. Otherwise the string contains just line and text.



26
27
28
29
30
 
# File 'lib/annotations/extractor.rb', line 26

def to_s(options={})
  s = "[%3d] " % line
  s << "[#{tag}] " if options[:tag]
  s << text
end