Class: Tap::Declarations::Description

Inherits:
Lazydoc::Comment
  • Object
show all
Defined in:
lib/tap/declarations/description.rb

Overview

A special type of Lazydoc::Comment designed to handle the comment syntax for task declarations.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#desc ⇒ Object

Returns the value of attribute desc.



7
8
9
 
# File 'lib/tap/declarations/description.rb', line 7

def desc
  @desc
end

Instance Method Details

#prepend(line) ⇒ Object 



9
10
11
12
13
14
15
16
 
# File 'lib/tap/declarations/description.rb', line 9

def prepend(line)
  if line =~ /::desc\s+(.*?)\s*$/
    self.desc = $1
    false
  else
    super
  end
end

#to_s ⇒ Object 



18
19
20
21
 
# File 'lib/tap/declarations/description.rb', line 18

def to_s
  resolve
  desc.to_s
end