Class: EasySwig::DoxygenTask

Inherits:
Object
  • Object
show all
Includes:
EasySwig
Defined in:
lib/tasks/doxygen_task.rb

Instance Method Summary collapse

Methods included from EasySwig

doxygen, generate, swig

Constructor Details

#initialize(config) ⇒ DoxygenTask

Returns a new instance of DoxygenTask.



6
7
8
9
10
11
12
13
14
15
 
# File 'lib/tasks/doxygen_task.rb', line 6

def initialize config
	@config = config
  if Dir.exists?(@config.doxy_dir)
    FileUtils.rm_r @config.doxy_dir
  end
  FileUtils.mkdir_p @config.doxy_dir

  @log = EasySwig::Logger.doxy_log(@config.doxy_dir)
  @log.info { "Created Doxygen directory in #{@config.doxy_dir}" }
end

Instance Method Details

#dispose ⇒ Object 



24
25
26
 
# File 'lib/tasks/doxygen_task.rb', line 24

def dispose
  @log.close
end

#generate ⇒ Object 



17
18
19
20
21
22
 
# File 'lib/tasks/doxygen_task.rb', line 17

def generate
  @log.info { "Creating Doxygen documentation in directory: #{@config.doxy_dir} ..." }
  headers_dirs = [@config.headers_dir]   
  output = Doxyparser::gen_xml_docs(headers_dirs, @config.doxy_dir, true, @config.includes_dir, @config.html, @config.stl_support)
  @log.info { 'Doxygen documentation created at: '+ @config.doxy_dir}
end