Class: Rake::Leaves::DoxygenTask

Inherits:
TaskLib
  • Object
show all
Defined in:
lib/leaves/doc/doxygen.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from TaskLib

#upaste

Constructor Details

#initialize {|_self| ... } ⇒ DoxygenTask

Returns a new instance of DoxygenTask.

Yields:

  • (_self)

Yield Parameters:



12
13
14
15
16
17
 
# File 'lib/leaves/doc/doxygen.rb', line 12

def initialize()
  @config = 'Doxyfile'
  
  yield self if block_given?
  define
end

Instance Attribute Details

#config ⇒ Object

Returns the value of attribute config.



10
11
12
 
# File 'lib/leaves/doc/doxygen.rb', line 10

def config
  @config
end

Instance Method Details

#define ⇒ Object 



19
20
21
22
23
24
25
26
 
# File 'lib/leaves/doc/doxygen.rb', line 19

def define
  desc "Generate documentation using Doxygen."
  task :doc do
    sh "doxygen #{@config}"
  end
  
  self
end